Adjust Nightly Build Settings (Pass 2)

[WhiredPlanck]

Pull request

Issue tracker

Fixes will automatically close the related issues

Fixes # N/A

Feature

Describe features of pull request

Code of conduct

• CONTRIBUTING

Style lint

• make sytle-lint

Build pass

• make debug

Manually test

• Done

Code Review

1. No wildcards import
2. Manual build and test pass
3. GitHub action ci pass
4. At least one contributor reviews and votes
5. Can be merged clean without conflicts
6. PR will be merged by rebase upstream base

Daily build

Login and download artifact at https://github.com/osfans/trime/actions

Additional Info

[Bambooin]

Seems nightly build will create default tag, this tag will affect the release note which depends on last tag.

https://github.com/ncipollo/release-action

An optional tag for the release. If this is omitted the git ref will be used (if it is a tag).

If we can build nightly only when there are new commits, it's an improvement.

[WhiredPlanck]

@Bambooin The nightly build only run on schedule (specified at UTC 3:00 everyday), and only run when develop branch has new commit:

trime/.github/workflows/nightly-ci.yml

Line 4 in 924a14a

- cron: '0 0 3 * * * *' # UTC 3:00 daily

trime/.github/workflows/nightly-ci.yml

Line 10 in 924a14a

if: ${{ github.repository == 'osfans/trime' && github.ref == 'refs/heads/develop' }}

The tag only will be created when we specify one or the value of github.ref is 'refs/tags/<tag_name>'.

[Bambooin]

The tag only will be created when we specify one or the value of github.ref is 'refs/tags/<tag_name>'.

I mean release.yml, such that when we decide to release v3.2.17 tag, then the last tag is nightly instead of v3.2.16.

trime/.github/workflows/release-ci.yml

Lines 70 to 81 in 30cb7c0

	- name: Build changelog
	id: build_changelog
	uses: mikepenz/release-changelog-builder-action@v4
	with:
	commitMode: true
	configurationJson: |
	{
	"template": "Change log from #{{FROM_TAG}} to #{{TO_TAG}}: #{{RELEASE_DIFF}}\n#{{UNCATEGORIZED}}",
	"pr_template": "- [#{{MERGE_SHA}}] - #{{TITLE}}"
	}
	env:
	GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

[WhiredPlanck]

The tag only will be created when we specify one or the value of github.ref is 'refs/tags/<tag_name>'.

I mean release.yml, such that when we decide to release v3.2.17 tag, then the last tag is nightly instead of v3.2.16.

trime/.github/workflows/release-ci.yml

Lines 70 to 81 in 30cb7c0

	- name: Build changelog
	id: build_changelog
	uses: mikepenz/release-changelog-builder-action@v4
	with:
	commitMode: true
	configurationJson: |
	{
	"template": "Change log from #{{FROM_TAG}} to #{{TO_TAG}}: #{{RELEASE_DIFF}}\n#{{UNCATEGORIZED}}",
	"pr_template": "- [#{{MERGE_SHA}}] - #{{TITLE}}"
	}
	env:
	GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

Just remove nightly tag, the new nightly configuration should not create a tag on the release.

[WhiredPlanck]

Hm, I'm too optimistic. If we don't specify tag or there is no valid git ref, the build will end up with failure. https://github.com/WhiredPlanck/trime-new/actions/runs/7600515837

[Bambooin]

So we have to find the workaroud on the nightly build without tag.

[WhiredPlanck]

So we have to find the workaroud on the nightly build without tag.

@Bambooin Great news: I just find that mikepenz/release-changelog-builder-action actually has a input option called ignorePreReleases. Since we will publish nightly build as a prerelease, it will be useful here.

P.S. Before I discovered this option, I was struggling to write bash scripts to ignore the nightly tag when to generate the changelog, which was a wasted effort 🤣 .