Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[maykinmedia/open-api-framework#96] Add quick-start.yml #9

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

danielmursa-dev
Copy link

@danielmursa-dev danielmursa-dev force-pushed the feature/add-quick-start branch from c518126 to 2090134 Compare February 3, 2025 13:06
steps:
- uses: actions/checkout@v4
- name: Start docker containers
run: docker compose up -d --build || ( docker compose logs >&2 && exit 1; )
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For my information: is the explicit exit 1 needed, wouldn't the build/bringing the containers up failing cause a non zero exit code by itself? In any case I think it's fine to use this to make sure the job fails if there are any errors

done
- name: Load fixtures
if: ${{ inputs.fixtures != '' }}
run: docker compose exec -T web src/manage.py loaddata ${{ inputs.fixtures }}
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Would it work if you pass multiple fixture names to fixtures?

Comment on lines +37 to +38
SUPERUSER="${{ inputs.superuser || 'admin' }}"
WEB_SERVICE="${{ inputs.web_service || 'web' }}"
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Since we're not testing logging in in this job, I don't think we have to make these variable, but as long as it's not required to pass them it's fine by me to leave this as is

docker compose exec -T $WEB_SERVICE src/manage.py createsuperuser --username $SUPERUSER --email [email protected] --no-input
- name: Check main page
run: |
curl_status=$(curl -w '%{http_code}' -o /dev/null -s http://localhost:8000/)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it might be good to make the port number variable (with 8000 as the default), currently all of them are probably 8000, but if we introduce any other numbers it's good to have this prepared for that

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add docker-compose quickstart job to all projects
2 participants