Skip to content

fix: allow custom package name when uploading generic_package assets #607

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.

Sign up for GitHub

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

Open
wants to merge 13 commits into
base: master
Choose a base branch
from
Open

fix: allow custom package name when uploading generic_package assets #607

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
67a6f6e
fix: support other channels on generic_package
henryaw Sep 28, 2023
72283df
Merge remote-tracking branch 'upstream/master' into use-channel-as-ge…
henryaw Aug 6, 2025
7de6fb5
add channelAsPkgName option
henryaw Aug 6, 2025
8e20357
lint code
henryaw Aug 6, 2025
4e2812c
allow to config package name
henryaw Aug 6, 2025
74b39e9
use filename if label is not exist
henryaw Aug 6, 2025
79e68ba
packageName is defined at the same config level as `asssets` for not …
henryaw Aug 6, 2025
91c6213
back to last commited code
henryaw Aug 6, 2025
642ca03
add unit tests, update readme
henryaw Aug 6, 2025
1c09117
don't assume filename as label
henryaw Aug 6, 2025
2ca4358
Merge remote-tracking branch 'upstream/master' into use-channel-as-ge…
henryaw Aug 8, 2025
a0da25d
resolve lint warns
henryaw Aug 8, 2025
da4d90c
Merge branch 'master' into use-channel-as-generic-package-name
fgreinacher Aug 12, 2025
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
13 changes: 8 additions & 5 deletions lib/publish.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,22 +11,22 @@ import resolveConfig from "./resolve-config.js";
import getRepoId from "./get-repo-id.js";
import getAssets from "./glob-assets.js";
import { RELEASE_NAME } from "./definitions/constants.js";
import semver from "semver";

const isUrlScheme = (value) => /^(https|http|ftp):\/\//.test(value);

export default async (pluginConfig, context) => {
const {
cwd,
options: { repositoryUrl },
nextRelease: { gitTag, gitHead, notes, version },
nextRelease: { gitTag, gitHead, notes, version, channel },
logger,
} = context;
const { gitlabToken, gitlabUrl, gitlabApiUrl, assets, milestones, proxy } = resolveConfig(pluginConfig, context);
const assetsList = [];
const repoId = getRepoId(context, gitlabUrl, repositoryUrl);
const encodedRepoId = encodeURIComponent(repoId);
const encodedGitTag = encodeURIComponent(gitTag);
const encodedVersion = encodeURIComponent(version);
const apiOptions = { headers: { "PRIVATE-TOKEN": gitlabToken } };

debug("repoId: %o", repoId);
Expand Down Expand Up @@ -88,11 +88,14 @@ export default async (pluginConfig, context) => {

if (target === "generic_package") {
// Upload generic packages
const encodedLabel = encodeURIComponent(label);
const { major, minor, patch } = semver.parse(version);
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If I understand that correct, this renders it impossible to use prereleases (alpha, beta).

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, this does not look correct. GitLab allows much more:

The package version. The following regex validates this: \A(.?[\w+-]+.?)+\z. You can test your version strings on Rubular.

const encodedVersion = `${major}.${minor}.${patch}`;
const encodedLabel = encodeURIComponent(label ?? version);
const encodedChannel = encodeURIComponent(channel ?? "release");
// https://docs.gitlab.com/ee/user/packages/generic_packages/#publish-a-package-file
uploadEndpoint = urlJoin(
gitlabApiUrl,
`/projects/${encodedRepoId}/packages/generic/release/${encodedVersion}/${encodedLabel}?${
`/projects/${encodedRepoId}/packages/generic/${encodedChannel}/${encodedVersion}/${encodedLabel}?${
status ? `status=${status}&` : ""
}select=package_file`
);
Expand All @@ -109,7 +112,7 @@ export default async (pluginConfig, context) => {
// https://docs.gitlab.com/ee/user/packages/generic_packages/#download-package-file
const url = urlJoin(
gitlabApiUrl,
`/projects/${encodedRepoId}/packages/generic/release/${encodedVersion}/${encodedLabel}`
`/projects/${encodedRepoId}/packages/generic/${encodedChannel}/${encodedVersion}/${encodedLabel}`
);

assetsList.push({ label, alt: "release", url, type: "package", filepath });
Expand Down
131 changes: 112 additions & 19 deletions package-lock.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@
"hpagent": "^1.0.0",
"lodash-es": "^4.17.21",
"parse-url": "^8.0.0",
"semver": "^7.3.2",
"url-join": "^4.0.0"
},
"devDependencies": {
Expand Down