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

move to setting set unstable := true in Justfile #271

Merged
merged 2 commits into from
Aug 2, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).

- Now using `django_twc_toolbox.views` for some core views. See the removed section below.
- Now using Sentry sampler functions from `django_twc_toolbox.sentry`. See the removed section below.
- Moved from recommending setting the `JUST_UNSTABLE=True` environment variable to using `set unstable := true` within template project's `Justfile`.

### Fixed

Expand Down
1 change: 0 additions & 1 deletion src/django_twc_project/.env.example.jinja
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,3 @@ DATABASE_URL={{ postgres_uri_scheme }}://postgres:postgres@db:5432/postgres
DEBUG=True
DJANGO_SETTINGS_MODULE={{ module_name }}.settings
EMAIL_RELAY_DATABASE_URL={{ postgres_uri_scheme }}://postgres:postgres@db:5432/email_relay
JUST_UNSTABLE=True
1 change: 1 addition & 0 deletions src/django_twc_project/Justfile.jinja
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
set dotenv-load := true
set unstable := true

mod copier ".just/copier.just"
mod dj ".just/django.just"
Expand Down
14 changes: 2 additions & 12 deletions src/django_twc_project/README.md.jinja
Original file line number Diff line number Diff line change
Expand Up @@ -22,17 +22,7 @@
git clone https://github.com/{{ github_owner }}/{{ github_repo }}
```

2. Export the `JUST_UNSTABLE` environment variable set to `true`.

The `Justfile` used to run all the command development commands takes advantage of just modules, which currently are marked as "unstable". The easiest way around this is to set this environment variable, otherwise you will need to preface every `just` command with the `--unstable` CLI flag.

```sh
export JUST_UNSTABLE=true
```

Alternatively, you can use a tool like [Direnv](https://direnv.net) to accomplish this as well.

3. Run the setup script:
2. Run the setup script:

```sh
just setup
Expand All @@ -53,7 +43,7 @@
- Lint the repository.
- Stop the Docker Compose stack.

4. After the setup script has successfully completed, you can start your development Docker Compose stack by running either of these commands:
3. After the setup script has successfully completed, you can start your development Docker Compose stack by running either of these commands:

```sh
# to start the containers detached in the background
Expand Down