Skip to content

Commit

Permalink
formatting and typo fixes to markdown
Browse files Browse the repository at this point in the history
  • Loading branch information
Mick Piereder committed Apr 12, 2024
1 parent 7b5db13 commit 31c65c7
Showing 1 changed file with 12 additions and 7 deletions.
19 changes: 12 additions & 7 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,24 +25,27 @@ References: [Developing inside a Container](https://code.visualstudio.com/docs/d

### local

If you prefer to develop locally you can download all the dependencies manaully: NodeJs, Typescript, Jest, etc
If you prefer to develop locally you can download all the dependencies manually: NodeJs, Typescript, Jest, etc

Then run:

```shell
npm install
```

Create the following environment variables:
Create the following environment variables:

```shell
duplo_token=XXXXX
duplo_host=https://XXXX.duplocloud.net
duplo_tenant_id=xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
duplo_tenant_name=default
```

## Running locally

In vscode, create a `.vscode/launch.json` file that looks like this:

```json
{
"version": "0.2.0",
Expand Down Expand Up @@ -82,10 +85,13 @@ node lib/main.js
## Running tests

Run tests locally by running either of these two commands on your terminal:

```shell
jest
```
or

or

```shell
npm test
```
Expand All @@ -98,7 +104,6 @@ To push changes to the repository, create a branch and push your changes to that

Build and package the code before opening a pull request. This will ensure that the code is packaged correctly and your changes are reflected in the action.


```shell
# Install dependencies
npm ci
Expand All @@ -115,15 +120,15 @@ sudo chmod -R a+w dist/

## Publishing

To publish the action to the marketplace,
To publish the action to the marketplace:

1. Run the `Start Release` workflow from the Actions tab in github. This will create a new release and publish the action `(release/x.x.x)` to the marketplace.
2. You can then test the action by creating a new workflow that uses the action. Reference the release branch in the workflow file. Example: `uses: duplocloud/ghactions-aws-jit@release/0.3.3`
3. Once you are satisfied with the changes, you can merge the release branch into `master`. This will publish the action to the marketplace. Example: `uses: duplocloud/ghactions-aws-jit@master`

### Versioning

The version of the action is defined in the `package.json` file. The version is automatically incremented when the `Start Release` workflow is run. The version is incremented based on the type of change that is being released. For example, if the last release was `v1.0.0` and the next release is a bug fix, the version will be `v1.0.1`.
The version of the action is defined in the `package.json` file. The version is automatically incremented when the `Start Release` workflow is run. The version is incremented based on the type of change that is being released. For example, if the last release was `v1.0.0` and the next release is a bug fix, the version will be `v1.0.1`.

If the next release is a feature, you'll need to provide a new version by bumping the minor version. Example: `v1.2.0`.
If the next release is a breaking change, you'll need to bump the major version. Example: `v2.0.0`.

0 comments on commit 31c65c7

Please sign in to comment.