diff --git a/Dockerfile b/Dockerfile index be5dd45..affb616 100644 --- a/Dockerfile +++ b/Dockerfile @@ -1,5 +1,5 @@ # Base image -FROM node:14.16.0-alpine3.13 +FROM node:18-alpine # Set working directory WORKDIR /app diff --git a/README.md b/README.md index 0e55f85..37f4370 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,46 @@ # jira-auto-scheduler -A JIRA auto-scheduling application for product management +A JIRA auto-scheduling application for product management. -Indicate confidence and estimate +## Features -Make it so a team can have epics in parallel +- Indicate confidence and estimate +- Make it so a team can have epics in parallel +- Add time and sprints +- Working days +- Start date and end date -Add time and sprints +# Deploying this app -Working days +This repo is set up with three GitHub Actions: -Start date and end date +## Deploy-PR + +1. This action runs *automatically* when any commit is pushed to a PR. +1. Each PR will create its own deployment "environment". + +## Destroy-PR + +1. This action runs *automatically* when any PR is closed. +1. It tears down the PR's deployed environment. + +## Deploy + +1. This action runs *automatically* on any commit to `main`. +1. It performs a new deploy to the existing `main` environment. + +# Deployment Info + +## Where is the app deployed? + +The apps get deployed to the Bitovi AWS instance **jira-integrations**. + +The Action creates an EC2 VM, installs docker on it, and then launches the application using `docker-compose`. + +The public URL of the application is displayed in the Summary tab of an Action's run. + +# Contact + +For application code questions, please raise an issue in this repo. + +Questions or comments about the app's deployment/operations can be aimed at the [devops team](mailto:devops@bitovi.com)!