Skip to content

Commit

Permalink
add release instructions to lpm readme (#395)
Browse files Browse the repository at this point in the history
  • Loading branch information
jnewton03 authored Jul 11, 2024
1 parent 008e554 commit 0c48fc1
Show file tree
Hide file tree
Showing 2 changed files with 32 additions and 1 deletion.
7 changes: 6 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,13 +57,14 @@ To load completions in your current shell session:
`source <(lpm completion bash)`

To load completions for every new session, execute once:

* Linux:

```shell
lpm completion bash > /etc/bash_completion.d/lpm
```

- MacOS:
* MacOS:

```shell
lpm completion bash > /usr/local/etc/bash_completion.d/lpm
Expand Down Expand Up @@ -94,3 +95,7 @@ This project is licensed under the Apache License 2.0. See the LICENSE file for
This project also includes software governed by the Mozilla Public License, v. 2.0.

* `github.com/hashicorp/go-version v1.6.0` (<http://mozilla.org/MPL/2.0/>)

## Releasing LPM

For instructions on releasing LPM, see [RELEASING.md](RELEASING.md).
26 changes: 26 additions & 0 deletions RELEASING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
# How to Release LPM

## Workflow Definitions

- **Release Workflow**:
- `create-release.yml` creates/updates the draft release when a push to master is made.
- **Attach Artifact Workflow**:
- `attach-artifact-release.yml` is a manually executed workflow with an input value to set the LPM version for the draft release.

## Attach Artifact Workflow Details

1. **Cleanup**: Retrieves the latest draft release and removes any old artifacts from previous runs.
2. **Set Release Name**: Uses the version input parameter to set the draft release name.
3. **Set Version File**: Updates the `VERSION` file in the repository with the version input parameter.
4. **Run Release Command**: Executes the `make release` command.
5. **Upload Artifacts**: Uploads each zip file to the draft release.
6. **SHA256 Summary**: Prints the sha256 checksums for `linux` and `linux-arm64` in the action run summary.

## Workflow Process

- **Automatic Draft Creation**: Every merged PR to master will create/update the draft release.
- **Manual Artifact Attachment**: When ready to release a new version, manually trigger the `Attach Artifact to Release` workflow with the new version.

### Final Steps

If everything looks good, finalize the draft release, and GitHub will attach the source code tar and zip files as usual.

0 comments on commit 0c48fc1

Please sign in to comment.