Skip to content

Update publish-dists.yml #31

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

Merged
Dargon789 merged 1 commit into from
Jun 1, 2025
Merged

Update publish-dists.yml #31

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
4 changes: 3 additions & 1 deletion .github/workflows/publish-dists.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,9 @@ jobs:
PKG_DIR="packages/$PACKAGE"

echo "📦 Publishing $PACKAGE to $BRANCH"

echo "prohibited_file" >> .gitignore
Copy link

@sourcery-ai sourcery-ai bot Jun 1, 2025

Choose a reason for hiding this comment

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

suggestion: Don’t modify .gitignore in CI

To exclude files from the published package, use .npmignore or the "files" field in package.json rather than modifying .gitignore during CI.

Suggested implementation:

            echo "📦 Publishing $PACKAGE to $BRANCH"
            mkdir -p /tmp/$PACKAGE
            shopt -s dotglob
            cp -r $PKG_DIR/* /tmp/$PACKAGE || true

To fully implement the suggestion, ensure that prohibited_file is excluded from the published package by adding it to .npmignore or by configuring the files field in package.json in the relevant package directory. No further changes are needed in the CI workflow.

git rm --cached prohibited_file
Copy link

@sourcery-ai sourcery-ai bot Jun 1, 2025

Choose a reason for hiding this comment

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

suggestion: Avoid using git rm in CI for packaging

Instead of modifying the repo state, delete the unwanted file directly from the package directory before publishing (e.g., rm /tmp/$PACKAGE/prohibited_file).

git commit -m "Remove prohibited_file"
Copy link

@sourcery-ai sourcery-ai bot Jun 1, 2025

Choose a reason for hiding this comment

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

issue (bug_risk): Committing in CI will likely fail and won’t push

CI workflows usually run in a detached HEAD without git user config, and there's no push step, so this commit will fail or do nothing. Filter out unwanted files from the build artifact instead.

mkdir -p /tmp/$PACKAGE
shopt -s dotglob
cp -r $PKG_DIR/* /tmp/$PACKAGE || true
Expand Down