Skip to content

Automate publishing to GitHub Packages and remove build artifacts from repo#22

Draft
Copilot wants to merge 4 commits intomainfrom
copilot/publish-ui-package-to-github
Draft

Automate publishing to GitHub Packages and remove build artifacts from repo#22
Copilot wants to merge 4 commits intomainfrom
copilot/publish-ui-package-to-github

Conversation

Copy link
Copy Markdown

Copilot AI commented Nov 25, 2025

Implements automated publishing to GitHub Packages on release and removes the /dist directory from version control per requirements.

Changes

Removed build artifacts from version control

  • Deleted /dist directory from repo
  • Added dist/ to .gitignore

Created publishing workflow (.github/workflows/publish.yml)

  • Triggers on release publication
  • Builds package and publishes to GitHub Packages registry
  • Uses GITHUB_TOKEN for authentication

Configured package for GitHub Packages

  • Added publishConfig pointing to https://npm.pkg.github.com
  • Created scripts/prepare-package.js to adjust paths when publishing from dist:
    • Corrects entry points (main, module, types) to be relative to dist
    • Preserves postinstall script and copies postinstall.cjs
    • Specifies files to include in published package

Updated installation documentation

  • Added GitHub Packages installation instructions with .npmrc configuration
  • Preserved repository-based installation as fallback

Usage

After release, users install via:

# Configure .npmrc
@uselagoon:registry=https://npm.pkg.github.com

# Install
npm install @uselagoon/ui-library

Package versioning follows existing semantic versioning in package.json.

Original prompt

This section details on the original issue you should resolve

<issue_title>Publish UI package to GitHub Packages</issue_title>
<issue_description>Request: Publish the resulting UI package from this repository to GitHub Packages so it can be consumed by other projects.

Details:

  • Automate CI/CD to publish new package versions upon release
  • Update documentation to indicate usage from GitHub Packages
  • Ensure package versioning is clear and follows semantic versioning

Acceptance Criteria:

  • UI package is available in GitHub Packages
  • Documentation updated for install instructions
  • Publishing process is automated as part of CI/CD pipeline</issue_description>

<agent_instructions>make sure that you remove the /dist directory from the repo since it should only be built when published</agent_instructions>

Comments on the Issue (you are @copilot in this section)


💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.

Copilot AI and others added 3 commits November 25, 2025 00:32
Co-authored-by: bomoko <297936+bomoko@users.noreply.github.com>
Co-authored-by: bomoko <297936+bomoko@users.noreply.github.com>
…eservation

Co-authored-by: bomoko <297936+bomoko@users.noreply.github.com>
Copilot AI changed the title [WIP] Publish UI package to GitHub Packages with automation Automate publishing to GitHub Packages and remove build artifacts from repo Nov 25, 2025
Copilot AI requested a review from bomoko November 25, 2025 00:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Publish UI package to GitHub Packages

2 participants