Skip to content

Commit

Permalink
Update docs for 1.6.0 release
Browse files Browse the repository at this point in the history
  • Loading branch information
andytson-inviqa committed Aug 21, 2023
1 parent 9e16a57 commit f0d6445
Show file tree
Hide file tree
Showing 10 changed files with 22 additions and 22 deletions.
22 changes: 11 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -171,22 +171,22 @@ We use Gitlab release notes to generate and store changelogs.

When ready to tag a release, make a new branch from the `1.6.x` branch for the changelog entries:

1. Draft a release (don't publish it) https://github.com/inviqa/harness-base-php/releases/new?tag=1.6.0&title=1.6.0&target=1.6.x
1. Draft a release (don't publish it) https://github.com/inviqa/harness-base-php/releases/new?tag=1.6.1&title=1.6.1&target=1.6.x
2. Click `Generate release notes`
3. Examine the release notes. For every entry in the `Other Changes` section, examine the Pull Requests
and assign each pull request either a `enhancement` label for a new feature, `bug` for a bugfix or `deprecated` for
a deprecation.
4. For each Pull Request in the release, assign an appropriate `harness-*` label.
5. Re-generate the changelog using step 2 as needed. Clearing the release notes to allow regeneration.
6. Adjust the version for each framework's README.md: `sed -i '' s/1\.5\.0/1.6.0/ README.md src/*/README.md src/*/docs/*.md src/*/docs/*/*.md`
6. Adjust the version for each framework's README.md: `sed -i '' s/1\.6\.0/1.6.1/ README.md src/*/README.md src/*/docs/*.md src/*/docs/*/*.md`
7. Commit the resulting changes, push and raise a pull request.
8. Once merged, continue with the release process below.

### Performing a Release

When you're ready to release:

1. Draft a new release https://github.com/inviqa/harness-base-php/releases/new?tag=1.6.0&title=1.6.0&target=1.6.x
1. Draft a new release https://github.com/inviqa/harness-base-php/releases/new?tag=1.6.1&title=1.6.1&target=1.6.x
2. Click `Generate release notes`
3. Publish the release
4. Ensure you are on the 1.6.x branch locally, and it's up to date
Expand All @@ -195,14 +195,14 @@ When you're ready to release:
6. Submit a pull request to [my127/my127.io] which adds the new release version and asset download URL for the
php-based harnesses to `harnesses.json`
7. Create a "Github Release" for downstream repositories, pasting in the changelog for the release from the previously generated release notes:
- https://github.com/inviqa/harness-php/releases/new?tag=1.6.0&title=1.6.0&target=1.6.x
- https://github.com/inviqa/harness-akeneo/releases/new?tag=1.6.0&title=1.6.0&target=1.6.x
- https://github.com/inviqa/harness-drupal/releases/new?tag=1.6.0&title=1.6.0&target=1.6.x
- https://github.com/inviqa/harness-magento1/releases/new?tag=1.6.0&title=1.6.0&target=1.6.x
- https://github.com/inviqa/harness-magento2/releases/new?tag=1.6.0&title=1.6.0&target=1.6.x
- https://github.com/inviqa/harness-spryker/releases/new?tag=1.6.0&title=1.6.0&target=1.6.x
- https://github.com/inviqa/harness-symfony/releases/new?tag=1.6.0&title=1.6.0&target=1.6.x
- https://github.com/inviqa/harness-wordpress/releases/new?tag=1.6.0&title=1.6.0&target=1.6.x
- https://github.com/inviqa/harness-php/releases/new?tag=1.6.1&title=1.6.1&target=1.6.x
- https://github.com/inviqa/harness-akeneo/releases/new?tag=1.6.1&title=1.6.1&target=1.6.x
- https://github.com/inviqa/harness-drupal/releases/new?tag=1.6.1&title=1.6.1&target=1.6.x
- https://github.com/inviqa/harness-magento1/releases/new?tag=1.6.1&title=1.6.1&target=1.6.x
- https://github.com/inviqa/harness-magento2/releases/new?tag=1.6.1&title=1.6.1&target=1.6.x
- https://github.com/inviqa/harness-spryker/releases/new?tag=1.6.1&title=1.6.1&target=1.6.x
- https://github.com/inviqa/harness-symfony/releases/new?tag=1.6.1&title=1.6.1&target=1.6.x
- https://github.com/inviqa/harness-wordpress/releases/new?tag=1.6.1&title=1.6.1&target=1.6.x

### Post-release actions

Expand Down
2 changes: 1 addition & 1 deletion src/_base/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
To use this harness:

1. Install [Workspace]
2. Run `ws create <projectName> inviqa/php:v1.5.0`
2. Run `ws create <projectName> inviqa/php:v1.6.0`
3. Fill in project-specific AWS and Github credentials, set as blank if you don't need them
4. Change to the <projectName> directory: `cd <projectName>`
5. Create an initial commit, ensuring that `workspace.override.yml` is not added to git:
Expand Down
4 changes: 2 additions & 2 deletions src/akeneo/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ with Akeneo, or use the community edition which is open source.
## Community Edition

1. Install [Workspace]
2. Run `ws create <projectName> inviqa/akeneo:v1.5.0`
2. Run `ws create <projectName> inviqa/akeneo:v1.6.0`
3. You will be asked a series of questions:
- For `akeneo.edition`, enter `community`
- For `akeneo.enterprise.distribution.project_name`, press enter to submit a blank string
Expand Down Expand Up @@ -34,7 +34,7 @@ git commit -m "Initial commit"
### Installation

1. Install [Workspace]
2. Run `ws create <projectName> inviqa/akeneo:v1.5.0`
2. Run `ws create <projectName> inviqa/akeneo:v1.6.0`
3. You will be asked a series of questions:
- For `akeneo.edition`, enter `enterprise`
- For `akeneo.enterprise.distribution.project_name`, enter the "Git repository" name listed on the Akeneo Portal
Expand Down
2 changes: 1 addition & 1 deletion src/drupal/docs/install/existing-project.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
```
From here, run the `ws create` command, but don't run the installation:
```bash
ws create <projectName> inviqa/drupal8:v1.5.0 --no-install
ws create <projectName> inviqa/drupal8:v1.6.0 --no-install
```
(Note: see [harnesses.json] for available versions.)
Expand Down
4 changes: 2 additions & 2 deletions src/drupal/docs/install/new-project.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
# Setting up Workspace on a new project
1. Use the `create` command to create a new project with the Drupal harness:
```
ws create <projectName> inviqa/drupal8:v1.5.0
ws create <projectName> inviqa/drupal8:v1.6.0
```
(Note: see [harnesses.json] for available versions.)
E.g.
```
ws create testProject inviqa/drupal8:v1.5.0
ws create testProject inviqa/drupal8:v1.6.0
```
This will create the new project in the current directory.
Expand Down
2 changes: 1 addition & 1 deletion src/magento1/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
To use this harness:

1. Install [Workspace]
2. Run `ws create <projectName> inviqa/magento1:v1.5.0`
2. Run `ws create <projectName> inviqa/magento1:v1.6.0`
3. Fill in project-specific AWS and Github credentials, set as blank if you don't need them
4. Change to the <projectName> directory: `cd <projectName>`
5. Create an initial commit, ensuring that `workspace.override.yml` is not added to git:
Expand Down
2 changes: 1 addition & 1 deletion src/magento2/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
To use this harness:

1. Install [Workspace]
2. Run `ws create <projectName> inviqa/magento2:v1.5.0`
2. Run `ws create <projectName> inviqa/magento2:v1.6.0`
3. Fill in project-specific AWS and Github credentials, set as blank if you don't need them
4. Change to the <projectName> directory: `cd <projectName>`
5. Create an initial commit, ensuring that `workspace.override.yml` is not added to git:
Expand Down
2 changes: 1 addition & 1 deletion src/spryker/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
To use this harness:

1. Install [Workspace]
2. Run `ws create <projectName> inviqa/spryker:v1.5.0`
2. Run `ws create <projectName> inviqa/spryker:v1.6.0`
3. Fill in project-specific AWS and Github credentials, set as blank if you don't need them
4. Change to the <projectName> directory: `cd <projectName>`
5. Create an initial commit, ensuring that `workspace.override.yml` is not added to git:
Expand Down
2 changes: 1 addition & 1 deletion src/symfony/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
To use this harness:

1. Install [Workspace]
2. Run `ws create <projectName> inviqa/symfony:v1.5.0`
2. Run `ws create <projectName> inviqa/symfony:v1.6.0`
3. Fill in project-specific AWS and Github credentials, set as blank if you don't need them
4. Change to the <projectName> directory: `cd <projectName>`
5. Create an initial commit, ensuring that `workspace.override.yml` is not added to git:
Expand Down
2 changes: 1 addition & 1 deletion src/wordpress/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
To use this harness:

1. Install [Workspace]
2. Run `ws create <projectName> inviqa/wordpress:v1.5.0`
2. Run `ws create <projectName> inviqa/wordpress:v1.6.0`
3. Fill in project-specific AWS and Github credentials, set as blank if you don't need them
4. Change to the <projectName> directory: `cd <projectName>`
5. Create an initial commit, ensuring that `workspace.override.yml` is not added to git:
Expand Down

0 comments on commit f0d6445

Please sign in to comment.