Skip to content

Commit

Permalink
Merge branch 'main' into sf/spelling-package
Browse files Browse the repository at this point in the history
  • Loading branch information
steve-fenton-octopus authored Oct 17, 2023
2 parents fff42ea + 697ba47 commit fde79b5
Show file tree
Hide file tree
Showing 116 changed files with 776 additions and 520 deletions.
16 changes: 14 additions & 2 deletions .github/workflows/build-astro.yml
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ jobs:
runs-on: ubuntu-latest

env:
SHOULD_DEPLOY: ${{ secrets.OCTOPUSSERVERURL != '' || '' }}
OCTOPUS_URL: ${{ secrets.OCTOPUSSERVERURL }}
OCTOPUS_API_KEY: ${{ secrets.OCTOPUSSERVERAPIKEY }}
OCTOPUS_SPACE: "DevOps Microsite"
Expand Down Expand Up @@ -88,26 +89,37 @@ jobs:
- name: Push a package to Octopus Deploy 🐙
uses: OctopusDeploy/[email protected]
if: ${{ env.SHOULD_DEPLOY }}
with:
packages: ${{ steps.package.outputs.package_file_path }}

- name: Let people download package
uses: actions/upload-artifact@v3
if: ${{ ! env.SHOULD_DEPLOY }}
with:
name: docs-microsite
path: ${{ steps.package.outputs.package_file_path }}

- name: Push build information to Octopus Deploy 🐙
uses: OctopusDeploy/push-build-information-action@v3
if: ${{ env.SHOULD_DEPLOY }}
with:
version: "${{ env.PACKAGE_VERSION }}"
packages: "Docs Microsite"

- name: Create a release in Octopus Deploy 🐙
uses: OctopusDeploy/create-release-action@v3
id: "create_release"
uses: OctopusDeploy/create-release-action@v3
if: ${{ env.SHOULD_DEPLOY }}
with:
project: "Docs Microsite"
package_version: "${{ env.PACKAGE_VERSION }}"
git_ref: ${{ github.ref }}

- name: Deploy the release in Octopus Deploy 🐙
uses: OctopusDeploy/deploy-release-action@v3
id: "queue_deployments"
uses: OctopusDeploy/deploy-release-action@v3
if: ${{ env.SHOULD_DEPLOY }}
with:
project: "Docs Microsite"
release_number: ${{ steps.create_release.outputs.release_number }}
Expand Down
11 changes: 5 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,11 @@ This repository contains the documentation for [Octopus Deploy](https://octopus.

Contributions to help improve this documentation are welcome, however, you must sign the [Contribution License Agreement (CLA)](https://cla-assistant.io/OctopusDeploy/docs) before we can accept your contribution.

See the [Octopus style guide](https://style.octopus.com) for information including:
See the [Octopus style guide](https://www.octopus.design/932c0f1a9/p/26f741-writing) for information including:

* [Markdown quick reference](https://style.octopus.com/markdown)
* [Capitalization](https://style.octopus.com/capitalization)
* [Working with images](https://style.octopus.com/images)
* [Predefined snippets to include in your text](https://style.octopus.com/octopus-snippets)
* [Markdown quick reference](https://www.octopus.design/932c0f1a9/p/074e30-markdown-reference)
* [Capitalization](https://www.octopus.design/932c0f1a9/p/457bc4-grammar-rules/t/03e016)
* [Working with images](https://www.octopus.design/932c0f1a9/p/5061d7-working-with-images)

## How to contribute a change to the docs

Expand Down Expand Up @@ -66,4 +65,4 @@ Before merging to `main` it's possible you'd like to see your changes in a previ
3. Run `pnpm dev` to run a local preview of the site
4. Open `localhost:3000` to view the site, the first page load usually takes a little time

You can generate a static copy of the site using `pnpm build` and run it in a browser with `pnpm preview`.
You can generate a static copy of the site using `pnpm build` and run it in a browser with `pnpm preview`.
10 changes: 8 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -22,14 +22,20 @@
"dependencies": {
"@astrojs/mdx": "^1.0.0",
"astro": "^3.0.3",
"astro-accelerator": "^0.3.10",
"astro-accelerator-utils": "^0.3.0",
"cspell": "^7.3.7",
"astro-accelerator": "^0.3.12",
"astro-accelerator-utils": "^0.3.2",
"hast-util-from-selector": "^3.0.0",
"remark-directive": "^2.0.1",
"remark-heading-id": "^1.0.1"
},
"devDependencies": {
"@playwright/test": "^1.37.1"
},
"pnpm": {
"overrides": {
"postcss@<8.4.31": ">=8.4.31",
"zod@<=3.22.2": ">=3.22.3"
}
}
}
Loading

0 comments on commit fde79b5

Please sign in to comment.