Skip to content

Commit bb25137

Browse files
committed
Merge remote-tracking branch 'upstream/main' into serializer-security-346
2 parents 3de5de4 + a1c35bb commit bb25137

File tree

6 files changed

+30
-24
lines changed

6 files changed

+30
-24
lines changed

.github/ISSUE_TEMPLATE/update-table.md

+9-3
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ assignees: ''
1010

1111
### Overview
1212
We need to update the [Replace with TABLE NAME] table model to [Replace with REASON]
13+
[possibly "to include new fields and have the correct names for fields."]
1314

1415
#### Details
1516
- The initial model issue: #[Replace with ISSUE NUMBER]
@@ -18,15 +19,18 @@ We need to update the [Replace with TABLE NAME] table model to [Replace with REA
1819
### Action Items
1920
Update existing Django model
2021
- [ ] In the files indicated by Resource 1.01, Change the following items in the code
21-
Current name in code | Updated Name
22-
-- | --
22+
Current name in code | Updated Name | Updated Type (may already be this type)
23+
-- | -- | --
2324
[Replace with UPDATE TABLE DATA]
2425

2526
- [ ] Add the following items in the code
27+
Name | Type
28+
-- | --
2629
[Replace with ADD TABLE]
2730
- [ ] Write a test for the new relationships this model will have with other models (e.g., creating a user and assigning them a set of permissions on a project) if any.
2831
- [ ] Update API end point
2932
- [ ] Update API unit tests
33+
- [ ] [generate a schema table definition](https://github.com/hackforla/peopledepot/issues/378#issuecomment-2493062821) and post it in a comment below and add a link to it in the Update Schema dependency issue.
3034
- [ ] Document the endpoint in ReDocs
3135

3236
### After PR has been approved
@@ -37,8 +41,10 @@ Current name in code | Updated Name
3741
- 1.01.01 [/app/core/models.py](https://github.com/hackforla/peopledepot/blob/main/app/core/models.py)
3842
- 1.01.02 [/app/core/admin.py](https://github.com/hackforla/peopledepot/blob/main/app/core/admin.py)
3943
- 1.01.03 [/app/core/api/serializers.py](https://github.com/hackforla/peopledepot/blob/main/app/core/api/serializers.py)
40-
- 1.01.04 [/app/core/migrations/0002_user_current_job_title_user_current_skills_and_more.py](https://github.com/hackforla/peopledepot/blob/main/app/core/migrations/0002_user_current_job_title_user_current_skills_and_more.py)
44+
- 1.01.04
4145
- 1.02 [People Depot Resources wiki page](https://github.com/hackforla/peopledepot/wiki/Resources-and-Links) for links
4246
- ERD
4347
- Table and Field Definitions
4448
- API Endpoint
49+
- 1.03 Spreadsheet: [PD: Table and field explanations, Field Permission tab](https://docs.google.com/spreadsheets/d/1x_zZ8JLS2hO-zG0jUocOJmX16jh-DF5dccrd_OEGNZ0/edit?gid=371053454#gid=371053454)
50+
-1.03.01 [ADD A LINK TO A SPECIFIC FILTER FOR THE TABLE]

.github/pull_request_template.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Fixes #replace_this_text_with_the_issue_number
1212
-
1313
-
1414

15-
### Screenshots of Proposed Changes Of The Website (if any, please do not screen shot code changes)
15+
### Screenshots of Proposed Changes Of The Website (if any, please do not screen shot code changes)
1616

1717
<!-- Note, if your images are too big, use the <img src="" width="" length="" /> syntax instead of ![image](link) to format the images -->
1818

.pre-commit-config.yaml

+13-13
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
# See https://pre-commit.com for more information
22
# See https://pre-commit.com/hooks.html for more hooks
33
default_install_hook_types: [pre-commit, pre-push]
4-
default_stages: [commit, push]
4+
default_stages: [pre-commit, pre-push]
55
minimum_pre_commit_version: "2.18"
66
repos:
77
- repo: https://github.com/pre-commit/pre-commit-hooks
8-
rev: v4.6.0
8+
rev: v5.0.0
99
hooks:
1010
# identify invalid files
1111
- id: check-ast
@@ -46,32 +46,32 @@ repos:
4646
- id: hadolint
4747

4848
- repo: https://github.com/asottile/pyupgrade
49-
rev: v3.16.0
49+
rev: v3.19.0
5050
hooks:
5151
- id: pyupgrade
5252
args: [--py310-plus]
5353

5454
- repo: https://github.com/adamchainz/django-upgrade
55-
rev: 1.19.0
55+
rev: 1.22.2
5656
hooks:
5757
- id: django-upgrade
5858
args: [--target-version, "4.0"]
5959

6060
- repo: https://github.com/psf/black-pre-commit-mirror
61-
rev: 24.4.2
61+
rev: 24.10.0
6262
hooks:
6363
- id: black
6464
exclude: ^app/core/migrations/
6565

6666
- repo: https://github.com/adamchainz/blacken-docs
67-
rev: 1.18.0
67+
rev: 1.19.1
6868
hooks:
6969
- id: blacken-docs
7070
additional_dependencies:
71-
- black==24.2.0
71+
- black==24.10.0
7272

7373
- repo: https://github.com/pycqa/flake8
74-
rev: 7.1.0
74+
rev: 7.1.1
7575
hooks:
7676
- id: flake8
7777
exclude: "^app/core/migrations/|^app/data/migrations/|^app/core/scripts"
@@ -100,7 +100,7 @@ repos:
100100
args: ["--filter-files", "--force-single-line-imports"]
101101

102102
- repo: https://github.com/PyCQA/bandit
103-
rev: 1.7.9
103+
rev: 1.8.0
104104
hooks:
105105
- id: bandit
106106
exclude: ^app/core/tests/
@@ -124,7 +124,7 @@ repos:
124124

125125
- repo: https://github.com/astral-sh/ruff-pre-commit
126126
# Ruff version.
127-
rev: v0.5.0
127+
rev: v0.8.1
128128
hooks:
129129
# Run the linter.
130130
- id: ruff
@@ -135,7 +135,7 @@ repos:
135135
exclude: ^app/core/migrations/
136136

137137
- repo: https://github.com/executablebooks/mdformat
138-
rev: 0.7.17
138+
rev: 0.7.19
139139
hooks:
140140
- id: mdformat
141141
exclude: |
@@ -156,7 +156,7 @@ repos:
156156
language: system
157157
pass_filenames: false
158158
always_run: true
159-
stages: [push]
159+
stages: [pre-push]
160160
- id: test
161161
name: test
162162
entry: ./scripts/test.sh
@@ -165,7 +165,7 @@ repos:
165165
always_run: true
166166
# verbose: true
167167
# require_serial: true
168-
stages: [push]
168+
stages: [pre-push]
169169

170170
ci:
171171
autoupdate_schedule: quarterly

docs/contributing/howto/run-local.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
# Run backend in venv
22

33
If you have a requirement to run on your local machine or you are unable to get it to work on
4-
Docker, do the following steps. WARNING: If you run into issues you will get limited support.
4+
Docker, do the following steps. WARNING: If you run into issues you will get limited support.
55

66
Run these commands from the `app` directory:
77

88
1. Copy `.env.docker-example` to `.env.local`
9-
1. Inspect `.env.local` and change values as appropriate. The file includes instructions on how to use local `postgres` and `sqlite` for the database. `sqlite` has no set up. It uses a file `db.sqlite3`. If it is not there, it automatically creates it.
10-
1. **Mac only**: If you have a Mac, the python command may not be found and scripts will fail. Try to run python using the "python" command from the terminal. If you get an error that the python command is
9+
1. Inspect `.env.local` and change values as appropriate. The file includes instructions on how to use local `postgres` and `sqlite` for the database. `sqlite` has no set up. It uses a file `db.sqlite3`. If it is not there, it automatically creates it.
10+
1. **Mac only**: If you have a Mac, the python command may not be found and scripts will fail. Try to run python using the "python" command from the terminal. If you get an error that the python command is
1111
not found, type: `alias python="python3"`
1212
1. Run these commands from the terminal in the project root.
1313

docs/contributing/tools/docker.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ RUN \
5050
pip install -r requirements.txt
5151
```
5252

53-
For pip, the files are by default stored in `/root/.cache/pip`. [Pip caching docs](https://pip.pypa.io/en/stable/topics/caching/)
53+
For pip, the files are by default stored in `/root/.cache/pip`. [Pip caching docs](https://pip.pypa.io/en/stable/topics/caching/)
5454

5555
For apk, the cache directory is `/var/cache/apk/`. [APK wiki on local cache](https://wiki.alpinelinux.org/wiki/Local_APK_cache)
5656

docs/howto/authenticate_cognito.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,11 @@ Prerequisites:
1010

1111
Steps:
1212

13-
1. Login (or register first then login) to a cognito account [here](https://hackforla-vrms-dev.auth.us-west-2.amazoncognito.com/login?client_id=3e3bi1ct2ks9rcktrde8v60v3u&response_type=token&scope=openid&redirect_uri=http://localhost:8000/admin). Do not worry if you see error messages - you will be using the url.
13+
1. Login (or register first then login) to a cognito account [here](https://hackforla-vrms-dev.auth.us-west-2.amazoncognito.com/login?client_id=3e3bi1ct2ks9rcktrde8v60v3u&response_type=token&scope=openid&redirect_uri=http://localhost:8000/admin). Do not worry if you see error messages - you will be using the url.
1414

1515
[<img src="https://user-images.githubusercontent.com/1160105/184449364-e3bba6e9-ced5-498f-a0e6-0c93c8a036fb.png" width="500" />](https://user-images.githubusercontent.com/1160105/184449364-e3bba6e9-ced5-498f-a0e6-0c93c8a036fb.png)
1616

17-
1. Copy the URL when it redirects. **Note:** Instead of the screen below, the screen may display an error message. You can ignore any error messages.
17+
1. Copy the URL when it redirects. **Note:** Instead of the screen below, the screen may display an error message. You can ignore any error messages.
1818

1919
[<img src="https://user-images.githubusercontent.com/1160105/184449368-f16b19de-9372-436c-b65d-c5afadbcbc1a.png" width="500" />](https://user-images.githubusercontent.com/1160105/184449368-f16b19de-9372-436c-b65d-c5afadbcbc1a.png).
2020

@@ -25,7 +25,7 @@ Steps:
2525

2626
[<img src="https://user-images.githubusercontent.com/1160105/184449537-2a9570a5-6361-48ae-b348-506244d592ac.png" width="500" />](https://user-images.githubusercontent.com/1160105/184449537-2a9570a5-6361-48ae-b348-506244d592ac.png)
2727

28-
1. Open [ModHeader](https://modheader.com/modheader/download). If the icon is hidden, click on the Puzzle icon in the upper right of the browser to see it.
28+
1. Open [ModHeader](https://modheader.com/modheader/download). If the icon is hidden, click on the Puzzle icon in the upper right of the browser to see it.
2929

3030
1. Type the word Bearer and paste the token into [ModHeader](https://docs.modheader.com/using-modheader/introduction) Authorization: Bearer \<access_token>
3131

0 commit comments

Comments
 (0)