Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: let's not store the release notes in the repository #1120

Merged
merged 6 commits into from
Nov 22, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 0 additions & 21 deletions .github/workflows/release.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -172,27 +172,6 @@ jobs:
git config user.name "GitHub Actions Bot"
git config user.email "<41898282+github-actions[bot]@users.noreply.github.com>"

- name: Update Release Notes File
env:
GITHUB_TOKEN: ${{ steps.generate_token.outputs.token }}
run: |
if git ls-remote --exit-code origin refs/tags/${{ env.RELEASE_VERSION }}; then
>&2 echo "tag ${{ env.RELEASE_VERSION }} already exists"
exit 2
fi
v="${{env.RELEASE_VERSION}}"
f="docs/releasenotes/$v.md"
if [ ! -f "$f" ]; then
echo "# Release ${{ env.RELEASE_VERSION }}" > "$f"
echo "$RELEASE_NOTES" | tail -n +2 >> "$f"
git add "$f"
git commit -m "ReleaseNotes for $RELEASE_VERSION"
git push origin ${GITHUB_REF#refs/heads/}
else
echo "Using release notes file $f from code base"
fi
echo "RELEASE_NOTES_FILE=$f" >> $GITHUB_ENV

- name: Create and Push Release
env:
GITHUB_TOKEN: ${{ steps.generate_token.outputs.token }}
Expand Down
17 changes: 0 additions & 17 deletions RELEASE_PROCESS.md
Original file line number Diff line number Diff line change
Expand Up @@ -222,23 +222,6 @@ them through all release candidates manually.
(TODO: this needs improvement by allowing us to do "append-only" style release
notes, see [this issue](https://github.com/open-component-model/ocm/issues/1097) for details)
hilmarf marked this conversation as resolved.
Show resolved Hide resolved

When a release is created, the release notes are copied to
the [./docs/releasenotes](./docs/releasenotes) folder in that branch
with a dedicated commit. If the release notes for that branch already exist in
the folder, the release notes are taken from the file
instead of the draft notes from GitHub. This means that you can also create a
Pull Request to the branch with the corresponding release notes
and it will be used for the release.
(TODO: Currently we have not decided if we want to permanently keep the notes
and thus need a PR to main to append them, or if we want to drop them in the
future. That's because they are currently needed to correctly manage notes
jakobmoellerdev marked this conversation as resolved.
Show resolved Hide resolved
over multiple release candidates, see
[this issue](https://github.com/open-component-model/ocm/issues/1097)
for details.)

By default, this file is generated from the
appropriate draft release with the basic release name (e.g. `v0.1.0-rc.1.md`).

## What is part of a release?

During the build of a release, an OCM CTF (Common Transport Format Archive) is
Expand Down
115 changes: 0 additions & 115 deletions docs/releasenotes/v0.1.0.md

This file was deleted.

18 changes: 0 additions & 18 deletions docs/releasenotes/v0.10.0.md

This file was deleted.

31 changes: 0 additions & 31 deletions docs/releasenotes/v0.11.0.md

This file was deleted.

23 changes: 0 additions & 23 deletions docs/releasenotes/v0.12.0.md

This file was deleted.

18 changes: 0 additions & 18 deletions docs/releasenotes/v0.13.0.md

This file was deleted.

21 changes: 0 additions & 21 deletions docs/releasenotes/v0.14.0.md

This file was deleted.

50 changes: 0 additions & 50 deletions docs/releasenotes/v0.15.0.md

This file was deleted.

42 changes: 0 additions & 42 deletions docs/releasenotes/v0.16.0.md

This file was deleted.

6 changes: 0 additions & 6 deletions docs/releasenotes/v0.2.0.md

This file was deleted.

Loading
Loading