7.3.2.5.1. Pre-Release Checklist

The bulk of the work to release each component is to verify that the component is ready for release. Below is the list of verifications that must be executed before proceeding with the release. If any of these steps fail, the problem identified must be fixed before you can proceed with the tag and release steps.

Verify a release is warranted
Verify the changelog
Verify RPMs can be created
Verify unit tests pass
Verify acceptance tests pass
Verify the component RPM upgrade succeeds
Verify the component yields valid SIMP ISOs

7.3.2.5.1.1. Verify a release is warranted

The check verifies a new release is warranted and the version has been properly updated.

Clone the component repository and checkout the development branch to be tagged

git clone https://github.com/simp/simp-adapter.git
cd simp-adapter
git checkout master # this step isn't needed for master branch

Run the pkg:compare_latest_tag rake task
```
bundle update
bundle exec rake pkg:compare_latest_tag
```
Important

If this check indicates no new tag is required, there is no reason to continue with the release procedures.

7.3.2.5.1.2. Verify the changelog

This check verifies that the CHANGELOG information can be properly extracted:

Run the pkg:create_tag_changelog rake task

bundle exec rake pkg:create_tag_changelog

Manually verify the changelog information is emitted and complete.
- It should begin with Release of x.y.z and then be followed by one or more comment blocks. For example,
```
Release of 6.0.3

* Thu Aug 10 2017 Nick Markowski <nmarkowski@keywcorp.com> - 6.0.3-0
  - Updated iptables::listen::tcp_stateful example to pass valid
    Iptables::DestPort types to dports
```
- It should be understandable.
- It should be free from typos.
- Any parsing error messages emitted should only be for changelog entries for earlier versions.

7.3.2.5.1.3. Verify RPMs can be created

This check verifies that an RPM can be generated for this module from simp-core:

Clone simp-core

git clone https://github.com/simp/simp-core.git``

Update the URL for the component under test Puppetfile.tracking, if needed
```
cd simp-core
vi Puppetfile.tracking
```
Build RPM

bundle update
bundle exec rake deps:checkout
bundle exec rake pkg:single[adapter]

Note

This command will build the RPM for the OS of the server on which it was executed.

7.3.2.5.1.4. Verify unit tests pass

This check verifies that the component’s unit tests have succeeded.

Navigate to the project’s GitHub Actions results page and verify the tests for the development branch to be tagged and released have passed. For our project, this page is https://github.com/simp/simp-adapter/actions

Important

If the tests are failing, you must fix them before proceeding. The automated release procedures will only succeed if the unit tests succeed.

7.3.2.5.1.5. Verify acceptance tests pass

This check verifies that the component’s acceptance tests have succeeded:

Run the appropriate acceptance test rake task, if it exists. For this project, rake beaker:suites is the appropriate task
```
bundle exec rake beaker:suites
```

Note

If the GitLab instance for the project is configured and current (it is sync’d every 3 hours), you can look at the latest acceptance test results run by GitLab. For our project, the results would be at https://gitlab.com/simp/simp-adapter/-/pipelines.

7.3.2.5.1.6. Verify the component RPM upgrade succeeds

This check verifies that the RPM for this component can be used to upgrade the last full SIMP release. For CentOS 7, do the following:

Bring up a CentOS server that was booted from the appropriate SIMP ISO and for which simp config and simp bootstrap has been run.

Note

If the VirtualBox for the last SIMP ISO was created by the simp-packer project, you can simply setup the appropriate VirtualBox network for that box and then bring up that bootstrapped image with vagrant up.
Copy the component RPM generated from the above RPM verification step to the server and install with yum. For example,
```
sudo yum install simp-adapter-0.0.3-0.el7.noarch.rpm
```
Note

If the component requires updated dependencies, those RPMs will have to be built and installed at the same time.
Verify the puppet agent runs succeed on the Puppet Server
- login as root
- execute puppet agent -t
Execute any other verifications unique to the component

7.3.2.5.1.7. Verify the component yields valid SIMP ISOs

This check verifies that with this component, valid SIMP ISOs for CentOS 7 can be built. An ISO is considered to be valid when a SIMP server can be booted from it, configured via simp config, and then bootstrapped via simp bootstrap. For CentOS 7:

Login to a machine that has Docker installed and the docker service running.

Important

In our development environment, the version of Docker that is available with CentOS works best.

Checkout the simp-core project for the last SIMP release. For this discussion, we will assume it is 6.0.0-1.

git clone https://github.com/simp/simp-core.git``
cd simp-core
git fetch -t origin
git checkout tags/6.0.0-1

Create a Puppetfile.tracking file that contains the contents of Puppetfile.stable in which the URLs for the component and any of its updated dependencies have been updated to reference the versions under test.

Populate simp-core/ISO directory with CentOS 7 distribution ISOs

mkdir ISO
cp /net/ISO/Distribution_ISOs/CentOS-7-x86_64-1708.iso ISO/

Build each ISO for CentOS. For example,

bundle update
SIMP_BUILD_docs=no \
SIMP_BUILD_verbose=yes \
SIMP_PKG_verbose=yes \
bundle exec rake beaker:suites[rpm_docker]

Important

The most reliable way to build each ISO is from a clean checkout of simp-core.

Use simp-packer to verify the SIMP ISO can be bootstrapped, when booted with the default options.