Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
42 changes: 42 additions & 0 deletions .github/workflows/release.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
name: Release

on:
workflow_dispatch:
inputs:
bump:
description: Which part of the version to raise.
required: true
type: choice
options:
- (choose one)
- patch
- minor
- major
dry_run:
description: Work out the next version and stop without publishing
required: false
type: boolean
default: false

# Two runs would otherwise claim the same version. The second fails safely at
# the release step, but serialising stops it happening at all.
#
# This belongs to the dispatched workflow rather than the called one, so every
# caller carries it. Copy this file rather than writing one.
concurrency: release

permissions: {}

jobs:
release:
uses: stacklet/github-tooling/.github/workflows/cut-release.yml@d5b3816baeac0706507e2119240fe0b793e1a1d3 # main
# The ceiling for the called workflow, not what each job gets. It narrows
# this to read for the job running the third-party action, and only its
# publish job keeps write.
permissions:
contents: write
secrets:
STEP_SECURITY_API_KEY: ${{ secrets.STEP_SECURITY_API_KEY }}
with:
bump: ${{ inputs.bump }}
dry_run: ${{ inputs.dry_run }}
16 changes: 14 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,8 +67,20 @@ No modules.

```hcl
module "cur-setup" {
source = "github.com/stacklet/terraform-aws-stacklet-cur-setup"
customer_prefix = ""
source = "stacklet/stacklet-cur-setup/aws"
version = "0.1.0"
Comment thread
johnsca marked this conversation as resolved.
Resolved

customer_prefix = ""
stacklet_saas_account_id = ""
}
```

## Versioning

This module is published to the [Terraform Registry](https://registry.terraform.io/modules/stacklet/stacklet-cur-setup/aws).
Comment thread
johnsca marked this conversation as resolved.
Resolved
Set `source` to the registry address and pin `version` to a release.

`version` takes the usual constraint syntax. This module is pre-1.0, and on a
0.x line a minor release is where it ships breaking changes, so pin at the
patch level: `~> 0.1.0` accepts `0.1.1` and later patches and holds at `0.2.0`.
Read the release notes before moving to a new minor.
Loading