Skip to content

Commit 2b1078c

Browse files
vicperdanaCopilot
andcommitted
docs: link RELEASING runbook + clean up legacy ADO release doc
Phase 1 finish + Phase 2 of the release-strategy work. - README.md: add 'see RELEASING.md' line under 'Changes and versioning'. - CONTRIBUTING.md: replace stale 'docs/release.md' link with link to RELEASING.md. - docs/release.md: replace ADO-flavored release doc (referenced obsolete Azure DevOps build numbers like 0.2.0-B2103003) with a stub pointing to RELEASING.md. - docs/publish/devops-wiki.md: page was a 'Coming soon' stub; expand it with both Azure Pipelines and GitHub Actions tabs covering the same scenario, matching the convention used elsewhere in the docs. - MONOREPO_MIGRATION.md: under 'Future Subtree Updates', add a callout reminding maintainers to delete upstream .azure-pipelines/ and nested .github/ directories after each subtree pull (the monorepo uses GH Actions only at the repo root). Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
1 parent 43f104a commit 2b1078c

5 files changed

Lines changed: 64 additions & 18 deletions

File tree

CONTRIBUTING.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,8 @@ Check out the links below to get started.
5757

5858
### Release Process
5959

60-
Refer to [release process](docs/release.md)
60+
See [RELEASING.md](RELEASING.md) for the full release runbook covering all three packages
61+
(PSDocs, PSDocs.Azure, VS Code extension), tag conventions, and the pre-release flow.
6162

6263
## Thank You!
6364

MONOREPO_MIGRATION.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -145,6 +145,20 @@ git subtree pull --prefix=packages/psdocs https://github.com/microsoft/PSDocs.gi
145145
git subtree pull --prefix=packages/vscode-extension https://github.com/microsoft/PSDocs-vscode.git main --squash
146146
```
147147

148+
> **After any subtree pull**, audit the result and remove anything we don't
149+
> want to inherit from upstream:
150+
>
151+
> - `packages/*/.azure-pipelines/` and `packages/*/azure-pipelines*.yaml`
152+
> the monorepo uses GitHub Actions (`/.github/workflows/`); upstream ADO
153+
> pipelines are not active here and should be deleted to avoid confusion.
154+
> - `packages/*/.github/workflows/` — workflows nested inside packages do
155+
> not run on GitHub. Either delete them or, if a workflow is genuinely
156+
> wanted, move and adapt it under root `.github/workflows/` with
157+
> appropriate path filters.
158+
> - Any upstream `.github/dependabot.yml` / `.github/CODEOWNERS` etc. —
159+
> monorepo policy lives at the repo root and should not be shadowed by
160+
> per-package copies.
161+
148162
## Workflow Migration
149163

150164
The following legacy workflows were removed as part of the monorepo migration, replaced by new workflows with path-based filtering:

README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -339,6 +339,8 @@ For a list of module changes please see the [change log](CHANGELOG.md).
339339
> Pre-release versions should be considered experimental.
340340
> Modules and change log details for pre-releases will be removed as standard releases are made available.
341341

342+
For maintainers cutting a release, see [RELEASING.md](RELEASING.md).
343+
342344
## Contributing
343345

344346
This project welcomes contributions and suggestions.

docs/publish/devops-wiki.md

Lines changed: 31 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,35 @@
1-
# Publish to Azure DevOps Wiki
1+
# Publish to a wiki
22

3-
Markdown generated with PSDocs for Azure can be published as wiki content for viewing with Azure DevOps.
3+
Markdown generated with PSDocs for Azure can be published as wiki content for
4+
viewing on Azure DevOps Wiki, GitHub Wiki, or any other Markdown-friendly
5+
documentation host.
46

57
!!! Abstract
6-
This topic covers using a pipeline to publish markdown generated by PSDocs for Azure into an Azure DevOps Wiki.
8+
This topic covers using a pipeline to publish markdown generated by
9+
PSDocs for Azure to either an Azure DevOps Wiki or a GitHub Wiki / GitHub
10+
Pages site.
711

8-
_Coming soon_.
12+
_Coming soon_ — detailed pipeline samples for both options.
13+
14+
In the meantime, the general approach is:
15+
16+
=== "Azure Pipelines"
17+
18+
1. Run `Invoke-PSDocument` against your templates in a build job, writing
19+
Markdown to a known output directory.
20+
2. Publish the output as a pipeline artifact.
21+
3. In a release stage, `git clone` the wiki repo (each Azure DevOps Wiki
22+
is backed by a Git repository), copy the artifact's Markdown into the
23+
wiki repo, commit, and push.
24+
25+
=== "GitHub Actions"
26+
27+
1. Run `Invoke-PSDocument` against your templates in a workflow job,
28+
writing Markdown to a known output directory.
29+
2. Either:
30+
- Push the Markdown to the repository's GitHub Wiki (the `*.wiki.git`
31+
repo) using a workflow such as
32+
[`Andrew-Chen-Wang/github-wiki-action`](https://github.com/Andrew-Chen-Wang/github-wiki-action), **or**
33+
- Publish the Markdown to GitHub Pages using the standard
34+
[`actions/deploy-pages`](https://github.com/actions/deploy-pages)
35+
flow with a static-site generator like MkDocs or Jekyll.

docs/release.md

Lines changed: 15 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,15 @@
1-
# Release process for PSDocs for Azure
2-
3-
The following sections describe the process for making a new release.
4-
5-
- Update [CHANGELOG](../CHANGELOG.md) with all changes since the last release (including all pre-release versions)
6-
- Submit a Pull Request for review
7-
- Navigate to [Releases](https://github.com/Azure/PSDocs.Azure/releases) and select **Draft a new release**
8-
- [SemVer](https://semver.org/) is used to version the releases. To use the correct release/tag the following options are used:
9-
- A stable release: increment from the previous release *e.g. v0.2.0*
10-
- A pre-release: select the **This is a pre-release** option and select the build version from the previous build in Azure DevOps Pipelines. This version can be found from previous build run. *E.g., for the recent Pull Request go to Pull Request -> Checks -> Analyze -> Azure Pipelines -> PSDocs.Azure-CI Build **[#0.2.0-B2103003](https://github.com/Azure/PSDocs.Azure/pull/52/checks?check_run_id=2066087539)***
11-
- Wait for the deployment to be released in [PowerShell Gallery](https://www.powershellgallery.com/packages/PSDocs.Azure/)
12-
- After a successful release, create another PR updating:
13-
- [.azure-pipelines/azure-pipelines.yaml](https://github.com/Azure/PSDocs.Azure/blob/main/.azure-pipelines/azure-pipelines.yaml) with the next version increment *e.g. if the newly released version is 0.2.0, set this to `version: '0.3.0'`*
1+
# Release process
2+
3+
The release process for all packages in this monorepo (PSDocs, PSDocs.Azure,
4+
VS Code extension) is documented in the repo-root [RELEASING.md][releasing]
5+
runbook.
6+
7+
That runbook covers:
8+
9+
- One-time setup of GitHub Actions secrets and the `release` environment.
10+
- Tag conventions per package (stable and preview).
11+
- Step-by-step instructions for cutting a release.
12+
- Pre-release flow for both PowerShell Gallery and VS Marketplace.
13+
- Troubleshooting and rollback.
14+
15+
[releasing]: https://github.com/Azure/PSDocs.Azure/blob/main/RELEASING.md

0 commit comments

Comments
 (0)