PromucFlow_constructor/.github/workflows/scripts/github-release/prelude.js
Shrikant Sharat Kandula 6905aa9f93
ci: Don't tag latest when not latest version (#38296)
When we're tagging a version that's not the latest version, then don't
update the `latest` Docker image on Docker hub. Like, if the current
latest is `v1.20`, and we publish the hotfix tag `v1.18.1` to fix a
critical bug in `v1.18`, then we only want to publish the Docker image
at the tag `v1.18.1`, and _not_ update `latest`. We want `latest` to
continue to point to `v1.20`.

Tested on a separate private repo, confirmed working.

## Communication
Should the DevRel and Marketing teams inform users about this change?
- [ ] Yes
- [x] No


<!-- This is an auto-generated comment: Cypress test results  -->
> [!WARNING]
> Tests have not run on the HEAD
21b3f9fe1ec7beea8b1f72b20f5406fb14fca4aa yet
> <hr>Sat, 21 Dec 2024 05:33:37 UTC
<!-- end of auto-generated comment: Cypress test results  -->


<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->

## Summary by CodeRabbit

- **New Features**
- Introduced a streamlined GitHub Actions workflow for Docker image
tagging.
	- Added a summary log for workflow execution details.
	- Enhanced Docker tag generation with validation and error handling.

- **Bug Fixes**
	- Improved validation for GitHub reference formats to prevent failures.

- **Documentation**
	- Updated workflow names and outputs for clarity and ease of use.

<!-- end of auto-generated comment: release notes by coderabbit.ai -->
2024-12-26 13:44:54 +05:30

54 lines
1.6 KiB
JavaScript

const { exec } = require("child_process");
module.exports = async function ({ core, context }, imageRepo) {
core.summary.addTable([
[{ data: "PWD", header: true }, process.cwd()],
[{ data: "GITHUB_REF", header: true }, context.ref],
[{ data: "GITHUB_SHA", header: true }, context.sha],
[{ data: "GITHUB_EVENT_NAME", header: true }, context.eventName],
]);
if (!context.ref?.match(/^refs\/tags\/v/)) {
core.setFailed(`Invalid tag: '${context.ref}'. Has to be like 'v1.22', 'v1.22.33' only.`);
return;
}
// Current version being tagged, including the 'v' prefix.
const thisVersion = context.ref.replace("refs/tags/", "");
core.setOutput("tag", thisVersion);
// The latest version of Appsmith available, including the 'v' prefix, including the currently tagged version.
const latestVersion = await getLatestTag();
// The docker tags to be pushed to the registry.
const dockerTags = [
`${imageRepo}:${thisVersion}`,
];
if (latestVersion === thisVersion) {
dockerTags.push(`${imageRepo}:latest`);
}
core.summary.addHeading("Docker image tags", 3);
core.summary.addCodeBlock(dockerTags.join("\n"));
core.setOutput("docker_tags", dockerTags.join("\n"));
core.summary.write();
}
function getLatestTag() {
return new Promise((resolve, reject) => {
exec("git tag --list --sort=-version:refname 'v*' | head -1", (error, stdout, stderr) => {
if (error) {
reject(`exec error: ${error}`);
return;
}
if (stderr) {
reject(`stderr: ${stderr}`);
return;
}
resolve(stdout.trim());
});
});
}