-
Notifications
You must be signed in to change notification settings - Fork 562
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
also corrected "NuGet" capitalizations and bumped version in RELEASE_NOTES
- Loading branch information
1 parent
8d0a5ed
commit 02dcb05
Showing
4 changed files
with
91 additions
and
7 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,81 @@ | ||
How To Use These Scripts To Release a New Build | ||
=============================================== | ||
|
||
About each script | ||
----------------- | ||
|
||
These are all Powershell scripts, so make sure you have Powershell installed. | ||
|
||
Run them with `pwsh <script>`. Some take a version param e.g. `v1.23.45`. | ||
|
||
### `Generate-Message-Sources.ps1` | ||
|
||
Runs the code generator, to regenerate the message/field classes from the Data Dictionary xml files. | ||
|
||
If you didn't change the DD, then this should have no effect. | ||
|
||
### `Delete-Generated-Sources.ps1` | ||
|
||
Deletes all generated sources. Occasionally useful. | ||
|
||
### `Bump-Versions.ps1` | ||
|
||
Updates the "Version" tag in each csproj file. | ||
|
||
### `Build-Zip-Release.ps1` | ||
|
||
Builds zips for each project and puts them in `<reporoot>/tmp/zip`. | ||
|
||
It will also leave unzipped archive dirs as artifacts. | ||
You can delete those if you don't need to see them. | ||
(This script deletes them when it starts each run.) | ||
|
||
### `Build-NuGets.ps1` | ||
|
||
Builds NuGet packages and puts them in `<reporoot>/tmp/nuget` | ||
|
||
### `Push-NuGets.ps1` | ||
|
||
Pushes the packages to NuGet.org. | ||
|
||
You need to set env var `NUGET_QFN_API_KEY`. To get a key, you need | ||
to make a nuget.org account and then then generate one in your profile. | ||
And then Grant needs to add you to the project. | ||
|
||
(You could instead manually upload all 10 packages to nuget.org via the web page, | ||
but that is painfully tedious.) | ||
|
||
|
||
AWS S3 tools setup (for uploading zips) | ||
--------------------------------------- | ||
|
||
These are Powershell modules. | ||
|
||
You'll need to have an AWS S3 account, and get AWS Access and Secret keys. | ||
|
||
``` | ||
pwsh | ||
# `pwsh` puts you into powershell | ||
Install-Module -Name AWS.Tools.S3 | ||
Update-Module -Name AWS.Tools.S3 | ||
``` | ||
|
||
The following command creates a local profile that stores your creds. | ||
It will be written to `~/.aws/credentials` | ||
Storing it as "default" makes powershell/AWS use it by default. | ||
|
||
``` | ||
Set-AWSCredentials -AccessKey <youraccesskey> -SecretKey <yoursecretkey> -StoreAs default | ||
``` | ||
|
||
Now you can use the `Write-S3Object` to upload the zip. | ||
|
||
|
||
Release-Creation Procedure | ||
-------------------------- | ||
|
||
This is documented here, for Connamara staff only: | ||
|
||
https://sites.google.com/connamara.com/internal-qfn-release-procedure/ | ||
|
||
|