Skip to content

Latest commit

 

History

History
51 lines (37 loc) · 2.53 KB

windows_instructions.md

File metadata and controls

51 lines (37 loc) · 2.53 KB
Raw

Installing PAC on Windows

  1. Download and install Ruby, let the installer add Ruby to PATH when given the option.
  2. Download DevKit and install it following the DevKit quick-start.
  3. Download and install cmake and pkg-config following instructions detailed in this SO answer.
  4. Download wkhtmltopdf and install it to a path that does not contain any spaces, for example C:\tools\wkhtmltopdf.
  5. Add an environment variable with the name wkhtmltopdf and the full path to the executable as value, for example C:\tools\wkhtmltopdf\bin\wkhtmltopdf.exe.
  6. Install bundler by running gem install bundler
  7. Clone the pac repository to your local machine: git clone https://github.com/Praqma/Praqmatic-Automated-Changelog.git.
  8. Optionally check-out the latest tag or a specific release tag if you don't want bleeding edge.
  9. Change directory to Praqmatic-Automated-Changelog (the git clone) and run the command bundle install to install all the used Ruby Gems.

Testing the installation

Open default_settings.yml and replace the :task_systems: block with the following:

:task_systems:
  - :name: none
    :regex:
      - { pattern: '/(CS-\d+)/i', label: none }
    :delimiter: '/,|\s/'

Set the repository location to the misc folder in the PAC project.

:repo_location: '..\Praqmatic-Automated-Changelog\misc'

In the above mentioned folder, create a sample repository containing a commit with the message CS-1, and a tag with the name v0.1. You can execute the following code snippet in the misc folder to quickly set up a small test repository:

git init
git commit --allow-empty -m "Initial commit"
git tag -a v0.1 -m "version 0.1"
git commit --allow-empty -m "CS-1"

Run ruby pac.rb from "v0.1" using the tag specified above.

Inspect the generated default.md file and check that it picked up the commit similar to this:

# PAC Changelog

## CS-1

- 045e2a3: CS-1


## Unspecified