StackStorm / StackStorm/st2-packages

[INFO] How to produce packages and debug an issue locally?

Open
#144 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

documentation
Dominant language
Shell
Stars
28
Forks
63
PR merge metrics
No merged PRs in 30d

Description

Generating packages locally

  1. Spin a fresh ubuntu VM
  2. Inside the VM, install the following pre-requisites
  3. Fetch the st2-packages repo and checkout the appropriate branch:
  4. Get ready to build:
    • sudo docker-compose kill
    • sudo docker-compose rm -f
  5. Now build packages:
    • sudo docker-compose run --rm wheezy # You can also run packages for trusty, el6, el7 etc

Debugging

After build and test stages finished all docker containers remain active, so you are welcome to some more in-depth testing if desired. To do so simply run:

  1. List containers
    • sudo docker ps

      Find the required testing container

      In our case it will be st2packages_wheezytest_1

  2. Get a shell inside container
    • sudo docker exec -it st2packages_wheezytest_1 bash

Once done, you are inside the testing environment where all services are up and running. Don't forget to do (after exec):

export TERM=xterm
At this point you can do any manual testing which is required.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

No target file or test is named. Start by locating the repository's existing package-build documentation and compare it with the Ubuntu, Docker Compose, package build, and container-debugging steps in the issue. Done means the local build and debugging procedure is documented accurately in the appropriate project location.

Written by the indexing model from the issue text.

Assessment

Tech stack
docker, docker-compose, shell
Domain
build-system, devops, documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.