Skip to content

Add workflow to create tag and release package #3

@saimizi

Description

@saimizi

Issue

We'd like to create a github action worflow to create a release.

  • Workflow is expected to be triggered when the PR which updates the version filed in Cargo.toml is merged into the main branch.
  • Create a release package as follow:
    • Following should be described in the release note:
      • The title is "v", where the is the value of version filed in Cargo.toml.
      • The ChangeLog from the previous release should be described in the body of release note.
    • The source tarball should be included in the release
    • Debian packages (.deb) of following architectures should be created and included in the release:
      • x86_64
      • arm64

Q&A

1. ChangeLog Format: Where is the ChangeLog maintained? Should I:

- Generate it from git commits between releases?
- Read from a CHANGELOG.md file?
- Extract from PR descriptions?

Answer: Generate it from git commits between release.

2. Version Detection: Should the workflow:

- Trigger on ANY change to Cargo.toml, or
- Only when the version field specifically changes?

Answer: Only when the version field is changed

3. Debian Package Metadata: What should I use for:

- Package maintainer information?
- Package description?
- Dependencies?

Answer: all these information are expected to be included.

4. Release Tagging: Should the workflow:

- Automatically create a git tag (e.g., v0.1.0)?
- Or expect tags to be created manually before the workflow runs?

Answer: A git tag like "v" should be created automatically for the release, where the should be match the version description in Cargo.toml.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions