Repository navigation
Release EmbedLedger 1.0.0 and fix module path aliases #2
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.
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
Merged
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,53 @@ | ||
| # Stability and upgrades | ||
|
|
||
| [Back to the README](../README.md) | ||
|
|
||
| ## The 1.x contract | ||
|
|
||
| EmbedLedger 1.x preserves the documented `scan`, `snapshot`, `check`, `version`, and `help` commands; existing flags and their defaults; and these exit codes: | ||
|
|
||
| | Exit code | Meaning | | ||
| | :--- | :--- | | ||
| | `0` | Complete inventory, saved baseline, or matching baseline | | ||
| | `1` | A complete comparison found added, removed, or changed assets | | ||
| | `2` | Invalid input, incompatible baseline, or an incomplete scan | | ||
|
|
||
| Schema-1 baselines retain their field names and meanings. Version 1.x continues to read existing valid schema-1 baselines. The JSON inventory and comparison fields documented in the [command reference](reference.md) retain their types and meanings. Additional commands and optional flags may be added; removing existing behavior or changing these formats requires a new major version. | ||
|
|
||
| A baseline comparison uses the recorded target OS, architecture, CGO setting, build tags, package selection, and test setting. Keep those options identical when saving and checking. The byte budget and timeout may differ. Go version is recorded as information and does not itself cause drift; Go's selected inputs can change between toolchains, so review any reported asset changes after a toolchain update. | ||
|
|
||
| Go 1.27 or newer must remain on PATH even when using a prebuilt executable. Native packages contain the CLI, MIT license, README, changelog, documentation, and the example module. The package filenames identify the OS and architecture that actually built and ran the package checks. These packages do not bundle Go. | ||
|
|
||
| ## Upgrade from 0.1.1 | ||
|
|
||
| Install the pinned source release: | ||
|
|
||
| ```sh | ||
| go install github.com/agammann/embedledger@v1.0.0 | ||
| embedledger version | ||
| ``` | ||
|
|
||
| The version output is `embedledger 1.0.0`. Alternatively, replace your previous executable with the verified native package for your OS and architecture. | ||
|
|
||
| Keep your reviewed `embedledger.json` and run `check` with the same options you used in 0.1.1: | ||
|
|
||
| ```sh | ||
| embedledger check --goos linux --goarch amd64 | ||
| ``` | ||
|
|
||
| The baseline format is unchanged; do not run `snapshot --force` merely to upgrade. If the check reports drift, review the inputs before deciding whether to accept a new baseline. Update the installation pin in your CI workflow separately. | ||
|
|
||
| ## Verify a native package | ||
|
|
||
| Each ZIP has a matching `.zip.sha256` file. Compare its hash with the ZIP before unpacking. The release also includes `SHA256SUMS` for all native ZIP files. | ||
|
|
||
| On Windows PowerShell: | ||
|
|
||
| ```powershell | ||
| Get-FileHash .\embedledger_1.0.0_windows_amd64.zip -Algorithm SHA256 | ||
| Get-Content .\embedledger_1.0.0_windows_amd64.zip.sha256 | ||
| ``` | ||
|
|
||
| On Linux, run `sha256sum -c` with the checksum filename. On macOS, run `shasum -a 256 -c` with it. Use the package matching your architecture. | ||
|
|
||
| After unpacking, use the CLI from the package directory or place it on PATH. Its included example baseline can be checked with `embedledger check --goos linux --goarch amd64`; this reports 112 bytes. In PowerShell, use `.\embedledger.exe` for the executable in the current directory. On macOS and Linux, use `./embedledger`. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
When three pushes to
mainarrive while the first workflow is still running, the shared top-level concurrency group keeps only the newest pending run even thoughcancel-in-progressis false; GitHub documents that an existing pending run is canceled unlessqueue: maxis enabled. Because publication occurs only within each push's workflow, this can silently discard a pending version-bump run, causing that version to be skipped entirely if the following push bumps again, or causing its tag to point at a later commit if the version remains unchanged. Queue all runs, or move serialization to the publish job so verified release commits cannot be replaced.Useful? React with 👍 / 👎.