Skip to content
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

Hotfix/v0.44.2 #49

Merged
merged 3 commits into from
Sep 4, 2024
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
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -79,9 +79,9 @@ The examples of Kubernetes providers, to which Kodjin has been installed already
- [K3D cluster provider for RMK](https://github.com/edenlabllc/k3d.provisioner.infra)
- [Helmfile hooks](https://github.com/edenlabllc/helmfile.hooks.infra)

## Development
## Development and release

The guidelines are available at https://edenlabllc.github.io/rmk/latest/https://edenlabllc.github.io/rmk/latest/development-and-release-flows/
The guidelines are available at https://edenlabllc.github.io/rmk/latest/development-and-release/

## License

Expand Down
2 changes: 1 addition & 1 deletion docs/.pages
Original file line number Diff line number Diff line change
Expand Up @@ -3,5 +3,5 @@ nav:
- quickstart.md
- Configuration and management: configuration
- Commands: commands.md
- development-and-release-flows.md
- development-and-release.md
collapse: false
4 changes: 2 additions & 2 deletions docs/commands.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,8 @@ rmk
Command line tool for reduced management of the provision of Kubernetes clusters in different environments and management of service releases.

**BuiltBy:** goreleaser <br />
**Commit:** 0370089 <br />
**Date:** 2024-09-03T16:41:40Z <br />
**Commit:** 7a0f199 <br />
**Date:** 2024-09-04T07:46:16Z <br />
**Target:** linux_amd64

**Usage**:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,11 +1,13 @@
# Development and release flow
# Development and release

## Requirements for the availability of tools during development
## Development

### Requirements for the availability of tools during development

- **[Golang](https://tip.golang.org/doc/install)** = v1.21.X
- **[GoReleaser](https://goreleaser.com/install)** = v1.23.0

## Building from source
### Building from source

To build RMK from source, run the following [GoReleaser](https://goreleaser.com/) command from the root of the repository:

Expand All @@ -15,12 +17,12 @@ goreleaser build --snapshot --clean

> You can also use this command for recompilation of RMK during development.

## Git workflow
### Git workflow

In RMK development, we use the classic [GitFlow](https://www.atlassian.com/git/tutorials/comparing-workflows/gitflow-workflow) workflow,
embracing all its advantages and disadvantages.

### Git branch naming conventions
#### Git branch naming conventions

- `feature/RMK-<issue_number>-<issue_description>`
- `release/<SemVer2>`
Expand All @@ -32,7 +34,7 @@ For example:
- `release/v0.42.0`
- `hotfix/v0.42.1`

## Release flow
## Release

After accumulating a certain set of features in the develop branch,
a `release/<SemVer2>` branch is created for the next release version.
Expand Down
8 changes: 6 additions & 2 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,10 +28,10 @@ Command line tool for reduced management and provisioning of Kubernetes clusters
* [Release management](configuration/release-management/release-management.md)
* [Secrets management](configuration/secrets-management/secrets-management.md)
* [Commands](commands.md)
* [Development and release flows](development-and-release-flows.md)
* [Features](#features)
* [Supported Kubernetes providers](#supported-kubernetes-providers)
* [Roadmap](#roadmap)
* [Development and release](development-and-release.md)
* [License](#license)
* [Code of Conduct](#code-of-conduct)

Expand Down Expand Up @@ -131,7 +131,7 @@ curl -sL "https://edenlabllc-rmk.s3.eu-north-1.amazonaws.com/rmk/s3-installer" |

Alternatively, you can go directly to https://github.com/edenlabllc/rmk/releases and download the binary.

As another option, the binary can be [built from source](development-and-release-flows.md#building-from-source).
As another option, the binary can be [built from source](development-and-release.md#building-from-source).

## Update

Expand Down Expand Up @@ -196,6 +196,10 @@ Among the providers are:

Check the [issues](https://github.com/edenlabllc/rmk/issues) for more information.

## Development and release

The guidelines are available at the [link](development-and-release.md).

## License

RMK is open source software (OSS) licensed under the [Apache 2.0 License](https://github.com/edenlabllc/rmk/blob/master/LICENSE).
Expand Down
3 changes: 1 addition & 2 deletions docs/release-notes.md
Original file line number Diff line number Diff line change
@@ -1,2 +1 @@
- #27 - Configured GitHub Pages documentation generation using MkDocs Materials, mike.
- #42 - Fixed markdown headers in rmk doc generate command.
- #27 - Fixed development-and-release.md guides, links to them from README.md and index.md.