Skip to content

Commit

Permalink
chore: smaller fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
Langleu committed Feb 27, 2025
1 parent 713e606 commit 8de1b81
Show file tree
Hide file tree
Showing 4 changed files with 4 additions and 40 deletions.
2 changes: 1 addition & 1 deletion .pre-commit-config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ repos:
rev: v0.9.0.6
hooks:
- id: shellcheck
args: [--external-sources, --source-path, .github/workflows/scripts, '--exclude=SC2154,SC2034,SC1091']
args: [--external-sources, --source-path, .github/workflows/scripts, '--exclude=SC1091,SC2034,SC2154,SC2155']

- repo: https://github.com/adrienverge/yamllint
rev: v1.35.1
Expand Down
1 change: 0 additions & 1 deletion .shellcheckrc

This file was deleted.

21 changes: 3 additions & 18 deletions aws/modules/DEVELOPER.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,10 @@ Welcome to the development reference for Camunda's Terraform EKS module! This do
To start developing or testing the EKS module, follow these steps:

1. **Clone the Repository:**
- Clone the repository from [camunda/camunda-tf-eks-module](https://github.com/camunda/camunda-tf-eks-module) to your local machine.
- Clone the repository from [camunda/camunda-deployment-references](https://github.com/camunda/camunda-deployment-references) to your local machine.

2. **Navigate to Test Suite:**
- Go to the `test/src` directory to access the test suite.
- Go to the `aws/modules/.test/src` directory to access the test suite.

3. **Test-Driven Development (TDD):**
- Use the Test-Driven Development approach to iterate on the module.
Expand All @@ -22,7 +22,7 @@ To start developing or testing the EKS module, follow these steps:
- Ensure to use a unique identifier for the cluster to avoid conflicts with existing resources.

5. **Testing Tools:**
- Refer to `test/README.md` for instructions on setting up and using testing tools.
- Refer to `.test/README.md` for instructions on setting up and using testing tools.
- Add fixtures and test cases using Terratest and Testify to validate module functionality.

6. **Cluster Cleanup:**
Expand All @@ -39,21 +39,6 @@ If you want to skip all tests, use `skip-tests:all`.
Remember, if all tests are skipped, the workflow will intentionally result in a `failed` status.
To skip tests without triggering an error, add the label `testing-ci-not-necessary` to the PR.

## Releasing a New Version

We follow Semantic Versioning (SemVer) guidelines for versioning. Follow these steps to release a new version:

1. **Commit History:**
- Maintain a clear commit history with explicit messages detailing additions and deletions.

2. **Versioning:**
- Determine the appropriate version number based on the changes made since the last release.
- Follow the format `MAJOR.MINOR.PATCH` as per Semantic Versioning guidelines.

3. **GitHub Releases:**
- Publish the new version on GitHub Releases.
- Tag the release with the version number and include release notes summarizing changes.

## Adding new GH actions

Please pin GitHub actions, if you need you can use [pin-github-action](https://github.com/mheap/pin-github-action) cli tool.
Expand Down
20 changes: 0 additions & 20 deletions aws/modules/MAINTENANCE.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,24 +5,6 @@ _Note: Please keep this document updated with any changes in maintenance procedu

## Maintenance Procedures

### Before New Releases

- Update documentation related to new features or changes.
- `README.md`
- Official Camunda documentation:
- [C8SM: Amazon EKS](https://github.com/camunda/camunda-docs/blob/main/docs/self-managed/setup/deploy/amazon/amazon-eks/amazon-eks.md)
- When releasing an update containing breaking changes, it should be accompanied by a migration guide in this repository to guide the user.

- Make internal announcements on Slack regarding upcoming releases.
- `#infex-internal`
- `#engineering` if relevant

- Refer to `DEVELOPER.md` to see the release process.

### After New Releases

_Nothing referenced yet._

## Dependencies

### Upstream Dependencies: dependencies of this project
Expand All @@ -35,8 +17,6 @@ _Nothing referenced yet._

## Actions

- Notify the **Product Management Team** of any new releases, especially if there are breaking changes or critical updates.

## Restrictions

- Never remove modules in the history of this repository, even if the sources are deprecated or removed.

0 comments on commit 8de1b81

Please sign in to comment.