Skip to content

Commit 95319f3

Browse files
authored
fix: Update github actions and readme (#12)
1 parent 98cf5ae commit 95319f3

File tree

5 files changed

+7
-11
lines changed

5 files changed

+7
-11
lines changed

.github/workflows/lint.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,5 +17,5 @@ jobs:
1717
run: pip install --upgrade ruff
1818
- name: Run ruff
1919
run: |
20-
ruff djangocms_rest
21-
ruff tests
20+
ruff check djangocms_rest
21+
ruff check tests

.github/workflows/publish-to-live-pypi.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ jobs:
1111
runs-on: ubuntu-latest
1212
environment:
1313
name: pypi
14-
url: https://pypi.org/p/djangocms-text
14+
url: https://pypi.org/p/djangocms-rest
1515
permissions:
1616
id-token: write
1717
steps:

.github/workflows/publish-to-test-pypi.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ jobs:
1111
runs-on: ubuntu-latest
1212
environment:
1313
name: test
14-
url: https://test.pypi.org/p/djangocms-text
14+
url: https://test.pypi.org/p/djangocms-rest
1515
permissions:
1616
id-token: write
1717
steps:

README.md

Lines changed: 2 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -8,11 +8,6 @@
88
djangocms-rest enables frontend projects to consume django CMS content through a browseable
99
read-only, REST/JSON API. It is based on the django rest framework (DRF).
1010

11-
For the following topics please see the ../README.md
12-
- installation and setup instructions
13-
- questions and support options
14-
- collaboration and contributions to this project
15-
1611
## What is headless mode?
1712

1813
A Headless CMS (Content Management System) is a backend-only content management system that provides
@@ -103,7 +98,7 @@ can be serialized.
10398

10499
Yes, djangocms-text has both HTML blob and structured JSON support for rich text.
105100

106-
URLs to other CMS objects are dynamic, in the form of `cms.object-name:<uid>`, for example
101+
URLs to other CMS objects are dynamic, in the form of `<app-name>.<object-name>:<uid>`, for example
107102
`cms.page:2`. The frontend can then use this to resolve the object and create the appropriate URLs
108103
to the object's frontend representation.
109104

@@ -124,7 +119,7 @@ content available via the REST API.
124119
Install using pip:
125120

126121
```bash
127-
pip install git+https://github.com/fsbraun/djangocms_rest@main
122+
pip install git+https://github.com/fsbraun/djangocms-rest@main
128123
```
129124

130125
Update your `INSTALLED_APPS` setting:

tests/test_rendering.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@
66
class RESTTestCase(CMSTestCase):
77
prefix = "http://testserver"
88

9+
910
class RenderingTestCase(RESTTestCase):
1011
def _create_pages(self, page_list, parent=None):
1112
new_pages = [create_page(

0 commit comments

Comments
 (0)