Skip to content

Commit

Permalink
rc2.0: Upload manifest files for release branch (#21175)
Browse files Browse the repository at this point in the history
Cherry-pick #21143 and
#20722
  • Loading branch information
sonalideshpandemsft authored May 21, 2024
1 parent f4b1441 commit b83f08b
Show file tree
Hide file tree
Showing 7 changed files with 276 additions and 256 deletions.
34 changes: 20 additions & 14 deletions build-tools/packages/build-cli/docs/release.md
Original file line number Diff line number Diff line change
Expand Up @@ -140,7 +140,7 @@ Generates a report of Fluid Framework releases.
```
USAGE
$ flub release report [--json] [-v | --quiet] [-i | -r | -s] [-g
client|server|azure|build-tools|gitrest|historian] [-o <value>]
client|server|azure|build-tools|gitrest|historian] [-o <value>] [--baseFileName <value>]
FLAGS
-g, --releaseGroup=<option>
Expand All @@ -166,6 +166,11 @@ FLAGS
-s, --highest
Always pick the greatest semver version as the latest (ignore dates).
--baseFileName=<value>
If provided, the output files will be named using this base name followed by the report kind (caret, simple, full,
tilde) and the .json extension. For example, if baseFileName is 'foo', the output files will be named
'foo.caret.json', 'foo.simple.json', etc.
LOGGING FLAGS
-v, --verbose Enable verbose logging.
--quiet Disable all logging.
Expand Down Expand Up @@ -208,30 +213,31 @@ _See code: [src/commands/release/report.ts](https://github.com/microsoft/FluidFr

## `flub release report-unreleased`

Creates a release report for the most recent build of the client release group published to an internal ADO feed. It does this by finding the most recent build in ADO produced from a provided branch, and creates a report using that version. The report is a combination of the "simple" and "caret" report formats. Packages released as part of the client release group will have an exact version range, while other packages, such as server packages or independent packages, will have a caret-equivalent version range.
Creates a release report for an unreleased build (one that is not published to npm), using an existing report in the "full" format as input.

```
USAGE
$ flub release report-unreleased --repo <value> --ado_pat <value> --sourceBranch <value> --output <value> [-v |
--quiet]
$ flub release report-unreleased --version <value> --outDir <value> --fullReportFilePath <value> --branchName <value> [-v |
--quiet]
FLAGS
--ado_pat=<value> (required) ADO Personal Access Token. This flag should be provided via the ADO_PAT environment
variable for security reasons.
--output=<value> (required) Output manifest file path
--repo=<value> (required) Repository name
--sourceBranch=<value> (required) Branch name across which the dev release manifest should be generated.
--branchName=<value> (required) Branch name. For release branches, the manifest file is uplaoded by build
number and not by current date.
--fullReportFilePath=<value> (required) Path to a report file in the 'full' format.
--outDir=<value> (required) Release report output directory
--version=<value> (required) Version to generate a report for. Typically, this version is the version of a
dev build.
LOGGING FLAGS
-v, --verbose Enable verbose logging.
--quiet Disable all logging.
DESCRIPTION
Creates a release report for the most recent build of the client release group published to an internal ADO feed. It
does this by finding the most recent build in ADO produced from a provided branch, and creates a report using that
version. The report is a combination of the "simple" and "caret" report formats. Packages released as part of the
client release group will have an exact version range, while other packages, such as server packages or independent
packages, will have a caret-equivalent version range.
Creates a release report for an unreleased build (one that is not published to npm), using an existing report in the
"full" format as input.
This command is primarily used to upload reports for non-PR main branch builds so that downstream pipelines can easily
consume them.
```

_See code: [src/commands/release/report-unreleased.ts](https://github.com/microsoft/FluidFramework/blob/main/build-tools/packages/build-cli/src/commands/release/report-unreleased.ts)_
Expand Down
Loading

0 comments on commit b83f08b

Please sign in to comment.