Add release guide to developer documentation#529
Conversation
Signed-off-by: Jan Bronicki <janbronicki@microsoft.com>
|
Azure Static Web Apps: Your stage site is ready! Visit it here: https://lemon-wave-085522403-529.westeurope.1.azurestaticapps.net |
Signed-off-by: Jan Bronicki <janbronicki@microsoft.com>
|
Azure Static Web Apps: Your stage site is ready! Visit it here: https://lemon-wave-085522403-529.westeurope.1.azurestaticapps.net |
|
Azure Static Web Apps: Your stage site is ready! Visit it here: https://lemon-wave-085522403-529.westeurope.1.azurestaticapps.net |
tormath1
left a comment
tormath1
left a comment
There was a problem hiding this comment.
Thanks for doing this, it's something we want to do since a while! I did a first round of review, it's good to see that some stuffs can be dropped. Let's wait for @sayanchowdhury and @dongsupark round of reviews as well to be sure we don't miss anything.
Thanks for this @John15321 !
content/docs/latest/reference/developer-guides/release-guide.md
Outdated
Show resolved
Hide resolved
content/docs/latest/reference/developer-guides/release-guide.md
Outdated
Show resolved
Hide resolved
content/docs/latest/reference/developer-guides/release-guide.md
Outdated
Show resolved
Hide resolved
content/docs/latest/reference/developer-guides/release-guide.md
Outdated
Show resolved
Hide resolved
content/docs/latest/reference/developer-guides/release-guide.md
Outdated
Show resolved
Hide resolved
content/docs/latest/reference/developer-guides/release-guide.md
Outdated
Show resolved
Hide resolved
| After completing all previous steps, update the `current` symlink: | ||
|
|
||
| ```bash | ||
| ssh core@origin.release.flatcar-linux.net | ||
| set-symlink.sh alpha:1786.0.0 beta:1781.2.0 | ||
| ``` | ||
|
|
||
| **Additional step during infrastructure migration:** |
There was a problem hiding this comment.
This is not accurate anymore.
There was a problem hiding this comment.
There is a button to apply a suggestion using AI if you have the GitHub plugin installed in VSCode, I just tried using that:
lmao I cant
content/docs/latest/reference/developer-guides/release-guide.md
Outdated
Show resolved
Hide resolved
| #### Security Notes Distribution | ||
|
|
||
| Post security notes (detailed CVE list) to: | ||
|
|
||
| * **Closed Kinvolk customers security announce group:** <https://groups.google.com/a/kinvolk.io/g/security-announce> | ||
|
|
||
| **Important:** Select the mailing list as sender. |
content/docs/latest/reference/developer-guides/release-guide.md
Outdated
Show resolved
Hide resolved
Co-authored-by: Mathieu Tortuyaux <mtortuyaux@microsoft.com>
Co-authored-by: Mathieu Tortuyaux <mtortuyaux@microsoft.com>
Co-authored-by: Mathieu Tortuyaux <mtortuyaux@microsoft.com>
Co-authored-by: Mathieu Tortuyaux <mtortuyaux@microsoft.com>
Co-authored-by: Mathieu Tortuyaux <mtortuyaux@microsoft.com>
Co-authored-by: Mathieu Tortuyaux <mtortuyaux@microsoft.com>
Co-authored-by: Mathieu Tortuyaux <mtortuyaux@microsoft.com>
Co-authored-by: Mathieu Tortuyaux <mtortuyaux@microsoft.com>
|
Azure Static Web Apps: Your stage site is ready! Visit it here: https://lemon-wave-085522403-529.westeurope.1.azurestaticapps.net |
4 similar comments
|
Azure Static Web Apps: Your stage site is ready! Visit it here: https://lemon-wave-085522403-529.westeurope.1.azurestaticapps.net |
|
Azure Static Web Apps: Your stage site is ready! Visit it here: https://lemon-wave-085522403-529.westeurope.1.azurestaticapps.net |
|
Azure Static Web Apps: Your stage site is ready! Visit it here: https://lemon-wave-085522403-529.westeurope.1.azurestaticapps.net |
|
Azure Static Web Apps: Your stage site is ready! Visit it here: https://lemon-wave-085522403-529.westeurope.1.azurestaticapps.net |
Signed-off-by: Jan Bronicki <janbronicki@microsoft.com>
|
Azure Static Web Apps: Your stage site is ready! Visit it here: https://lemon-wave-085522403-529.westeurope.1.azurestaticapps.net |
Signed-off-by: Jan Bronicki <janbronicki@microsoft.com>
|
Azure Static Web Apps: Your stage site is ready! Visit it here: https://lemon-wave-085522403-529.westeurope.1.azurestaticapps.net |
|
Azure Static Web Apps: Your stage site is ready! Visit it here: https://lemon-wave-085522403-529.westeurope.1.azurestaticapps.net |
|
Azure Static Web Apps: Your stage site is ready! Visit it here: https://lemon-wave-085522403-529.westeurope.1.azurestaticapps.net |
|
Azure Static Web Apps: Your stage site is ready! Visit it here: https://lemon-wave-085522403-529.westeurope.1.azurestaticapps.net |
1 similar comment
|
Azure Static Web Apps: Your stage site is ready! Visit it here: https://lemon-wave-085522403-529.westeurope.1.azurestaticapps.net |
|
Azure Static Web Apps: Your stage site is ready! Visit it here: https://lemon-wave-085522403-529.westeurope.1.azurestaticapps.net |
|
Azure Static Web Apps: Your stage site is ready! Visit it here: https://lemon-wave-085522403-529.westeurope.1.azurestaticapps.net |
|
|
||
| **The `flatcar-MAJOR` branch:** | ||
|
|
||
| * Introduces new features to the channels |
There was a problem hiding this comment.
I don't undestand this line. Maybe this sentence would need a rephrase. This is a long running branch so text feels a bit confusing to me.
content/docs/latest/reference/developer-guides/release-guide.md
Outdated
Show resolved
Hide resolved
| #### Version Numbering | ||
|
|
||
| * **New major version on Alpha:** Starts with `MAJOR.0.0` | ||
| * **Point releases:** Increment the patch version (same channel) or minor version (channel promotion) |
There was a problem hiding this comment.
Our version does not really reflect of the semver and creates confusion to someone new.
I've started to use the naming for our versions as EPOCH.STREAM.REVISION or MAJOR.CHANNEL.REVISION
What do you think? @tormath1
There was a problem hiding this comment.
Correct. MAJOR.CHANNEL.REVISION sounds better (STREAM is used by FCOS and we document "channel" in the whole documentation)
content/docs/latest/reference/developer-guides/release-guide.md
Outdated
Show resolved
Hide resolved
| **Pin specific commits:** | ||
|
|
||
| To adjust to specific commits or recreate tags with pinned commits: | ||
|
|
||
| ```bash | ||
| # Pin specific commits (useful for cherry-picking fixes) | ||
| OVERLAY_REF=<COMMIT_SHA> PORTAGE_REF=<COMMIT_SHA> \ | ||
| VERSION=<VERSION> SDK_VERSION=<SDK_VERSION> CHANNEL=<CHANNEL> ./tag-release | ||
|
|
||
| # Example pinning overlay commit: | ||
| OVERLAY_REF=c1b0fd2e3dcf17c463672643fee10deac152fe5f \ | ||
| VERSION=4564.3.0 SDK_VERSION=4564.0.0 CHANNEL=stable ./tag-release | ||
|
|
||
| # Example pinning all three repositories: | ||
| SCRIPTS_REF=abc123def456 \ | ||
| OVERLAY_REF=def456ghi789 \ | ||
| PORTAGE_REF=ghi789jkl012 \ | ||
| VERSION=4564.3.0 SDK_VERSION=4564.0.0 CHANNEL=stable ./tag-release | ||
| ``` |
There was a problem hiding this comment.
I agree this is no longer required.
|
|
||
| **Requirements:** | ||
|
|
||
| * Same value for `SDK_VERSION` and `VERSION` used with `create-manifest` |
There was a problem hiding this comment.
This should be removed correct?
There was a problem hiding this comment.
Correct, this can be dropped.
content/docs/latest/reference/developer-guides/release-guide.md
Outdated
Show resolved
Hide resolved
Co-authored-by: Sayan Chowdhury <schowdhury@microsoft.com>
|
Azure Static Web Apps: Your stage site is ready! Visit it here: https://lemon-wave-085522403-529.westeurope.1.azurestaticapps.net |
Signed-off-by: Jan Bronicki <janbronicki@microsoft.com>
|
Azure Static Web Apps: Your stage site is ready! Visit it here: https://lemon-wave-085522403-529.westeurope.1.azurestaticapps.net |
Signed-off-by: Jan Bronicki <janbronicki@microsoft.com>
|
Azure Static Web Apps: Your stage site is ready! Visit it here: https://lemon-wave-085522403-529.westeurope.1.azurestaticapps.net |
| #### Version Numbering | ||
|
|
||
| * **New major version on Alpha:** Starts with `MAJOR.0.0` | ||
| * **Point releases:** Increment the patch version (same channel) or minor version (channel promotion) |
There was a problem hiding this comment.
Correct. MAJOR.CHANNEL.REVISION sounds better (STREAM is used by FCOS and we document "channel" in the whole documentation)
|
|
||
| **Requirements:** | ||
|
|
||
| * Same value for `SDK_VERSION` and `VERSION` used with `create-manifest` |
There was a problem hiding this comment.
Correct, this can be dropped.
content/docs/latest/reference/developer-guides/release-guide.md
Outdated
Show resolved
Hide resolved
Co-authored-by: Mathieu Tortuyaux <mtortuyaux@microsoft.com>
|
Azure Static Web Apps: Your stage site is ready! Visit it here: https://lemon-wave-085522403-529.westeurope.1.azurestaticapps.net |
dongsupark
left a comment
dongsupark
left a comment
There was a problem hiding this comment.
Looks good. Minor comments below:
content/docs/latest/reference/developer-guides/release-guide.md
Outdated
Show resolved
Hide resolved
content/docs/latest/reference/developer-guides/release-guide.md
Outdated
Show resolved
Hide resolved
content/docs/latest/reference/developer-guides/release-guide.md
Outdated
Show resolved
Hide resolved
Co-authored-by: Dongsu Park <dongsu@dpark.io>
Co-authored-by: Dongsu Park <dongsu@dpark.io>
Co-authored-by: Dongsu Park <dongsu@dpark.io>
|
Azure Static Web Apps: Your stage site is ready! Visit it here: https://lemon-wave-085522403-529.westeurope.1.azurestaticapps.net |
2 similar comments
|
Azure Static Web Apps: Your stage site is ready! Visit it here: https://lemon-wave-085522403-529.westeurope.1.azurestaticapps.net |
|
Azure Static Web Apps: Your stage site is ready! Visit it here: https://lemon-wave-085522403-529.westeurope.1.azurestaticapps.net |
tormath1
left a comment
tormath1
left a comment
There was a problem hiding this comment.
Some last minute comments, but it looks good to me for a first iteration. The documentation reads on the preview, thanks! For next release, one can try to follow this one to see if anything is missing or unclear.
| B --> C[Testing] | ||
| C --> D[Release Job] |
There was a problem hiding this comment.
Let's add the go/no-go meeting here between those two items.
| D --> E[Artifact Distribution] | ||
| E --> F[Update Payloads] |
There was a problem hiding this comment.
Can we have those two in parallels?
| C --> D[Release Job] | ||
| D --> E[Artifact Distribution] | ||
| E --> F[Update Payloads] | ||
| F --> G[Publication] |
There was a problem hiding this comment.
Let' s mention 1. Payload promotion on Nebraska 2. Public announcements (social accounts, mailing list)
|
|
||
| 1. Configure WireGuard for `hub.pub.kinvolk.io` | ||
| 2. Access the dashboard at: <http://jenkins.infra.kinvolk.io:8080> | ||
| 3. Find the admin password in [flatcar/flatcar-linux-build-secrets](https://github.com/flatcar/flatcar-linux-build-secrets) |
There was a problem hiding this comment.
What admin password? One needs to ask a Jenkins admin first to create an account in Jenkins.
|
|
||
| **Requirements:** | ||
|
|
||
| * Same value for `SDK_VERSION` and `VERSION` used with `create-manifest` |
|
Azure Static Web Apps: Your stage site is ready! Visit it here: https://lemon-wave-085522403-529.westeurope.1.azurestaticapps.net |
4 participants
[Title: describe the change in one sentence]
[ describe the change in 1 - 3 paragraphs ]
How to use
[ describe what reviewers need to do in order to validate this PR ]
Testing done
[Describe the testing you have done before submitting this PR. Please include both the commands you issued as well as the output you got.]
changelog/directory (user-facing change, bug fix, security fix, update)/bootand/usrsize, packages, list files for any missing binaries, kernel modules, config files, kernel modules, etc.