Skip to content

RELEASE.md

Latest commit

 

History

History
131 lines (87 loc) · 3.13 KB

RELEASE.md

File metadata and controls

131 lines (87 loc) · 3.13 KB

Release Process

This action uses a release-based distribution model to avoid committing large dist/ files to the repository.

How It Works

  1. The dist/ folder is NOT committed to the main branch (it's in .gitignore)
  2. When you push a version tag (e.g., v1.0.0), the release workflow:
    • Builds the action (pnpm run package)
    • Creates a releases/v1 branch (or updates it if it exists)
    • Commits the built dist/ files to that release branch
    • Updates the major version tag (e.g., v1) to point to the release branch
    • Creates a GitHub release

Creating a Release

1. Update Version

Update the version in package.json:

# For patch releases (bug fixes)
pnpm version patch

# For minor releases (new features)
pnpm version minor

# For major releases (breaking changes)
pnpm version major

This will create a git tag automatically.

2. Push the Tag

git push origin main --follow-tags

The release workflow will automatically:

  • Build the distribution files
  • Create/update a release branch (e.g., releases/v1)
  • Commit the built files to the release branch
  • Update the major version tag (e.g., v1) to point to the release branch
  • Create a GitHub release

Using the Action

Users can reference your action in three ways:

1. Major Version (Recommended)

- uses: logickoder/firebase-distribution@v1

This automatically gets the latest v1.x.x release. The major version tag is automatically updated when you release new versions.

2. Specific Version

- uses: logickoder/firebase-distribution@v1.2.3

This pins to a specific version for maximum stability.

3. Branch

- uses: logickoder/firebase-distribution@main

Note: The main branch doesn't contain dist/, so this won't work for production. Use release tags instead.

Development Workflow

Testing Unreleased Changes

To test changes before releasing:

  1. Create a development release with a pre-release tag:
git tag v1.0.0-alpha.1
git push origin v1.0.0-alpha.1
  1. Reference it in your workflow:
- uses: logickoder/firebase-distribution@v1.0.0-alpha.1

Local Development

For local development, you can still build and test:

# Build the action
pnpm run package

# The dist/ folder will be created locally but won't be committed

Benefits

✅ Clean Main Branch - No large dist/ files in main branch history
✅ Cleaner PRs - Pull requests only show source code changes
✅ Isolated Builds - Built files separated in release branches
✅ Works with GitHub Actions - Users reference tags/branches directly
✅ Standard Practice - Follows common GitHub Actions patterns

Troubleshooting

"Action not found" Error

If users get an error that the action can't be found:

  1. Ensure you've pushed at least one version tag
  2. Check that the release workflow completed successfully
  3. Verify the tag follows semantic versioning (e.g., v1.0.0)

Major Version Tag Not Updating

The major version tag (e.g., v1) only updates for stable releases. Pre-release versions (alpha, beta, rc) don't update the major version tag.