liquidvotingio / liquidvotingio/api

Create a manually triggered Github Action to run smoke test

Open
#99 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Elixir
Stars
17
Forks
3
PR merge metrics
No merged PRs in 30d

Description

For running smoke test of deployed API (other than the automated smoke test that runs immediately after each new (re)deploy))

See [manually triggered workflow dispatch](https://docs.github.com/en/actions/configuring-and-managing-workflows/configuring-a-workflow#manually-running-a-workflow), for reference.

Notes:
- This issue will probably require repeated push -> merge cycles while developing.
- Instructions related to this manual action would be well placed within a section in the `deployment/smoke_tests/readme.md`.

Contributor guide

Open the contributing guide

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

Start with the GitHub Actions workflow configuration and the deployed API smoke-test entry point, using the linked workflow_dispatch documentation as reference. Read deployment/smoke_tests/readme.md for the intended instructions. Done means a workflow can be triggered manually to run the deployed API smoke test and the usage instructions are documented.

Written by the indexing model from the issue text.

Assessment

Tech stack
elixir, github-actions
Domain
api, ci-cd, testing
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.