Release process follow ups #220

glennmoy · 2023-10-24T11:35:03Z

This knocks out some of items in #210 namely:

workflow_dispatch should take as an input the commit sha to use as tag (to enable backports)
Pre-Release workflow should check project.version !in tags to allow back ports
Set as “latest release” in Publish Release
release are based on changes since previous tag
stable documenter builds are based on Releases

Not solved yet:

how to automatically trigger artifacts_CI workflow after triggering Pre_release CI using workflow_dispatch (seems to ignore that it's a workflow_dispatch and doesn't trigger it)

To see the specific tasks where the Asana app for GitHub is being used, see below:
- https://app.asana.com/0/0/1205785985070962

codecov · 2023-10-24T13:59:58Z

Codecov Report

Merging #220 (ba45577) into main (5f22740) will increase coverage by 1.13%.
Report is 8 commits behind head on main.
The diff coverage is n/a.

❗ Current head ba45577 differs from pull request most recent head a8bf476. Consider uploading reports for the commit a8bf476 to get more accurate results

@@            Coverage Diff             @@
##             main     #220      +/-   ##
==========================================
+ Coverage   96.98%   98.12%   +1.13%     
==========================================
  Files          12       12              
  Lines         663      639      -24     
==========================================
- Hits          643      627      -16     
+ Misses         20       12       -8

Flag	Coverage Δ
Ray.jl	`98.12% <ø> (+1.13%)`	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

see 4 files with indirect coverage changes

📣 Codecov offers a browser extension for seamless coverage viewing on GitHub. Try it in Chrome or Firefox today!

.github/workflows/Pre_release.yml

omus · 2023-10-24T15:53:38Z

.github/workflows/Pre_release.yml

        id: project_toml
        shell: julia --color=yes --project {0}
        env:
          LATEST_TAG: ${{ steps.latest_tag.outputs.tag }}
        run: |
          using Pkg.Types
          project = read_project("Project.toml")
-          latest_tag = parse(VersionNumber, ENV["LATEST_TAG"])
+          tags = parse.(VersionNumber, split(readchomp(`git tag -l`), "\n"))


Just curious if you verified this? I thought maybe we'd have to do git fetch --tags

yup it seems to work https://github.com/beacon-biosignals/Ray.jl/actions/runs/6630217614/job/18011182410?pr=220#step:3:18

If we create a tag that isn't a version number this will break. We should do:

Suggested change

tags = parse.(VersionNumber, split(readchomp(`git tag -l`), "\n"))

tags = split(readchomp(`git tag -l`), "\n")

and do a string comparison later.

Also, we can simplify this to:

Suggested change

tags = parse.(VersionNumber, split(readchomp(`git tag -l`), "\n"))

tags = readlines(`git tag -l`)

.github/workflows/Pre_release.yml

This reverts commit 88b36c4.

glennmoy · 2023-10-25T14:34:41Z

looking into using worflow_run as suggested elsewhere, I don't think this will work as it only runs the workflow against branches and not tags https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows#limiting-your-workflow-to-run-based-on-branches

omus · 2023-10-25T14:41:01Z

looking into using worflow_run as suggested elsewhere, I don't think this will work as it only runs the workflow against branches and not tags https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows#limiting-your-workflow-to-run-based-on-branches

Do we need to use workflow_run on tags? Why not use push.tags as the event if you want an action to run on a tag?

glennmoy · 2023-10-25T14:43:40Z

Do we need to use workflow_run on tags? Why not use push.tags as the event?

Well, I was exploring it as push.tags isn't being triggered for some reason, even though when triggered via workflow_dispatch it should allow downstream workflows to be triggered https://github.blog/changelog/2022-09-08-github-actions-use-github_token-with-workflow_dispatch-and-repository_dispatch/

For instance: v0.0.3 is still in pre-release because artifacts_CI.yml hasn't run on it. Even though, presumably, you kicked off Pre_release.yml manually.

.github/workflows/Pre_release.yml

glennmoy · 2023-11-01T16:57:47Z

.github/workflows/Pre_release.yml

@@ -80,10 +82,9 @@ jobs:
          git tag $tag ${{ steps.commit.outputs.sha }}
          git push origin $tag
      - name: Publish Pre-Release
-        uses: softprops/action-gh-release@v1
+        uses: ncipollo/release-action@v1


switching to this action as it allows us to set the rlease as "latest release"

glennmoy · 2023-11-01T17:02:49Z

I think the reason the release notes are whack is because our tag is not targetting the main branch

https://github.com/orgs/community/discussions/5975#discussioncomment-1799743

One of the issues folks have been running into here are repositories that are using advanced release strategies with release branches. The new regex is not going to help in those cases.
Our release generating tool is built on top of Pull-Requests and requires that your PRs target the same target branch that the release is created from.

glennmoy · 2023-11-01T17:04:24Z

I'll note I'm following along with ncipollo/release-action#198 to see if there's a workaround

glennmoy · 2023-11-01T17:38:01Z

I've found https://github.com/mikepenz/release-changelog-builder-action and will look to generate the changelog from that

glennmoy · 2023-11-01T17:53:33Z

Ok I'm calling this a win

Project.toml

omus

One last thing

omus · 2023-11-06T21:14:39Z

.github/workflows/Pre_release.yml

        id: project_toml
        shell: julia --color=yes --project {0}
        env:
          LATEST_TAG: ${{ steps.latest_tag.outputs.tag }}
        run: |
          using Pkg.Types
          project = read_project("Project.toml")
-          latest_tag = parse(VersionNumber, ENV["LATEST_TAG"])
+          tags = parse.(VersionNumber, split(readchomp(`git tag -l`), "\n"))


If we create a tag that isn't a version number this will break. We should do:

Suggested change

tags = parse.(VersionNumber, split(readchomp(`git tag -l`), "\n"))

tags = split(readchomp(`git tag -l`), "\n")

and do a string comparison later.

Also, we can simplify this to:

Suggested change

tags = parse.(VersionNumber, split(readchomp(`git tag -l`), "\n"))

tags = readlines(`git tag -l`)

.github/workflows/Pre_release.yml

glennmoy added 6 commits October 24, 2023 12:11

Pass in commit to branch from when makign a new tag

d01470e

Pass BEACON_BUDDY_GH_TOKEN

3e11e3b

Commit + Push Tag in same step

931f69d

Check project.version against all tags

e24f1f9

use ncipollo/release action

7d79350

add permisssions

601f06d

glennmoy force-pushed the gm/release_followups branch from c68bcfa to 601f06d Compare October 24, 2023 11:38

glennmoy added 3 commits October 24, 2023 13:19

REVERT: test pre-release workflow on push

a44a982

add version number to gha

36199b5

test for new version

c24d884

omus reviewed Oct 24, 2023

View reviewed changes

glennmoy added 4 commits October 24, 2023 18:08

piggyback off DOCUMENTER_KEY instead

448be44

delete LATEST_TAG env variable

b7afa56

remove quotes

44a65fa

don't persist credentials

1c216c1

glennmoy force-pushed the gm/release_followups branch from b00fb32 to 1c216c1 Compare October 24, 2023 18:52

pass DOCUMENTER key as env variable

5a30daa

glennmoy force-pushed the gm/release_followups branch from a15ffc4 to 5a30daa Compare October 24, 2023 22:00

glennmoy added 6 commits October 24, 2023 23:09

remove tag from release action since it should exist

e67d4b1

remove DOCUMENTER_KEY from git tag stage

88b36c4

Revert "remove DOCUMENTER_KEY from git tag stage"

46c90b9

This reverts commit 88b36c4.

REVERT: split up commit / tag

71bb53d

Revert to commit that worked yesterdat

3dbbece

shouldn't need commit info

1925e53

don't need DOCUMENTER_KEY

9fb8585

glennmoy force-pushed the gm/release_followups branch from b41a60e to 9fb8585 Compare November 1, 2023 16:13

glennmoy added 5 commits November 1, 2023 16:15

Commit and Tag in seperate steps

7fd9341

pass sha along

b8876c3

remove DOCUMENTER_KEY

6271ae8

rename artifacts_CI -> Release

8916e10

update docs

307ba3a

glennmoy commented Nov 1, 2023

View reviewed changes

.github/workflows/Pre_release.yml Outdated Show resolved Hide resolved

glennmoy commented Nov 1, 2023

View reviewed changes

glennmoy force-pushed the gm/release_followups branch from 20f8156 to 439b588 Compare November 1, 2023 17:38

Build changelogs using GHA

de45f66

glennmoy force-pushed the gm/release_followups branch from 439b588 to de45f66 Compare November 1, 2023 17:41

don't autogenerate release notes

290cd7c

glennmoy added 2 commits November 1, 2023 17:55

tidy up

ea8304d

Run Documenter workflow on Releases rather than Tags

ba45577

glennmoy requested a review from omus November 1, 2023 18:14

glennmoy commented Nov 2, 2023

View reviewed changes

Project.toml Outdated Show resolved Hide resolved

glennmoy added the fix fixes a bug or documentation label Nov 2, 2023

kleinschmidt linked an issue Nov 2, 2023 that may be closed by this pull request

Stable documentation is updated with pre-releases #185

Closed

Update Project.toml

eaa7341

omus approved these changes Nov 6, 2023

View reviewed changes

allow comparison of non-version number tags

a8bf476

glennmoy force-pushed the gm/release_followups branch from f51d8a0 to a8bf476 Compare November 7, 2023 14:03

glennmoy merged commit aaef10a into main Nov 7, 2023
1 check passed

glennmoy deleted the gm/release_followups branch November 7, 2023 14:05

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Release process follow ups #220

Release process follow ups #220

glennmoy commented Oct 24, 2023 •

edited by kleinschmidt

Loading

codecov bot commented Oct 24, 2023 •

edited

Loading

omus Oct 24, 2023

glennmoy Oct 24, 2023

omus Nov 6, 2023 •

edited

Loading

glennmoy commented Oct 25, 2023

omus commented Oct 25, 2023 •

edited

Loading

glennmoy commented Oct 25, 2023 •

edited

Loading

glennmoy Nov 1, 2023

glennmoy commented Nov 1, 2023

glennmoy commented Nov 1, 2023

glennmoy commented Nov 1, 2023

glennmoy commented Nov 1, 2023

omus left a comment

omus Nov 6, 2023 •

edited

Loading

	tags = parse.(VersionNumber, split(readchomp(`git tag -l`), "\n"))
	tags = split(readchomp(`git tag -l`), "\n")

	tags = parse.(VersionNumber, split(readchomp(`git tag -l`), "\n"))
	tags = readlines(`git tag -l`)

Release process follow ups #220

Release process follow ups #220

Conversation

glennmoy commented Oct 24, 2023 • edited by kleinschmidt Loading

codecov bot commented Oct 24, 2023 • edited Loading

Codecov Report

omus Oct 24, 2023

Choose a reason for hiding this comment

glennmoy Oct 24, 2023

Choose a reason for hiding this comment

omus Nov 6, 2023 • edited Loading

Choose a reason for hiding this comment

glennmoy commented Oct 25, 2023

omus commented Oct 25, 2023 • edited Loading

glennmoy commented Oct 25, 2023 • edited Loading

glennmoy Nov 1, 2023

Choose a reason for hiding this comment

glennmoy commented Nov 1, 2023

glennmoy commented Nov 1, 2023

glennmoy commented Nov 1, 2023

glennmoy commented Nov 1, 2023

omus left a comment

Choose a reason for hiding this comment

omus Nov 6, 2023 • edited Loading

Choose a reason for hiding this comment

glennmoy commented Oct 24, 2023 •

edited by kleinschmidt

Loading

codecov bot commented Oct 24, 2023 •

edited

Loading

omus Nov 6, 2023 •

edited

Loading

omus commented Oct 25, 2023 •

edited

Loading

glennmoy commented Oct 25, 2023 •

edited

Loading

omus Nov 6, 2023 •

edited

Loading