Skip to content

Commit a3acdab

Browse files
committed
docs: move Status down, add Node.js versioning policy
1 parent d6e33d2 commit a3acdab

File tree

1 file changed

+50
-37
lines changed

1 file changed

+50
-37
lines changed

README.md

Lines changed: 50 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -42,43 +42,6 @@ And please give some love to our featured sponsors 🤩:
4242
is instantly regenerated (without server restart) whenever the database
4343
changes
4444

45-
## Status
46-
47-
**STABLE**
48-
49-
This project is intended to be consumed via the CLI, which is stable and is
50-
being used in production in many projects. The CLI doesn't have explicit tests
51-
(PR welcome!), but it's a thin wrapper around the programmatic API which has
52-
copious tests.
53-
54-
The programmatic API is deliberately undocumented; it is not a public interface
55-
at this time (though it is fully typed in TypeScript). We reserve the right to
56-
make breaking changes to the programmatic API in patch releases (though this has
57-
not happened yet and is unlikely to happen without good reason). Should you need
58-
to use the programmatic API, please get in touch to encourage us to make this a
59-
supported interface ─ we'd love to know how you're using it!
60-
61-
The project as a whole is stable, but the approach is still "experimental", in
62-
particular:
63-
64-
- because committed migrations are hashed you cannot edit old migrations; this
65-
may cause you issues should you upgrade PostgreSQL and it drops support for a
66-
syntax or feature you were previously using. We plan to fix this issue _if and
67-
when_ it occurs, so if this affects you please open a detailed issue.
68-
- the approach of up-only and re-runnable migrations is not for the faint of
69-
heart ─ it requires solid SQL knowledge and if insufficient attention is paid
70-
it could result in your migrations and your local database state drifting
71-
apart (see 'Drift' below).
72-
73-
If you don't understand what makes Graphile Migrate awesome, you may want to
74-
consider an alternative migration framework such as these awesome (and quite
75-
diverse) projects:
76-
77-
- [db-migrate](https://db-migrate.readthedocs.io/en/latest/Getting%20Started/commands/)
78-
- [sqitch](https://sqitch.org/)
79-
- [Flyway](https://flywaydb.org/)
80-
- [migra](https://github.com/djrobstep/migra)
81-
8245
## Opinions
8346

8447
- Local iteration should be easy and _fast_
@@ -743,6 +706,56 @@ Since "superuser" has a specific meaning and is not strictly required for these
743706
activities we avoid that term, however you may find that you use a superuser as
744707
your root user - this is expected.
745708
709+
## Status
710+
711+
**STABLE**
712+
713+
This project is intended to be consumed via the CLI, which is stable and is
714+
being used in production in many projects. The CLI doesn't have explicit tests
715+
(PR welcome!), but it's a thin wrapper around the programmatic API which has
716+
copious tests.
717+
718+
The programmatic API is deliberately undocumented; it is not a public interface
719+
at this time (though it is fully typed in TypeScript). We reserve the right to
720+
make breaking changes to the programmatic API in patch releases (though this has
721+
not happened yet and is unlikely to happen without good reason). Should you need
722+
to use the programmatic API, please get in touch to encourage us to make this a
723+
supported interface ─ we'd love to know how you're using it!
724+
725+
The project as a whole is stable, but the approach is still "experimental", in
726+
particular:
727+
728+
- because committed migrations are hashed you cannot edit old migrations; this
729+
may cause you issues should you upgrade PostgreSQL and it drops support for a
730+
syntax or feature you were previously using. We plan to fix this issue _if and
731+
when_ it occurs, so if this affects you please open a detailed issue.
732+
- the approach of up-only and re-runnable migrations is not for the faint of
733+
heart ─ it requires solid SQL knowledge and if insufficient attention is paid
734+
it could result in your migrations and your local database state drifting
735+
apart (see 'Drift' below).
736+
737+
If you don't understand what makes Graphile Migrate awesome, you may want to
738+
consider an alternative migration framework such as these awesome (and quite
739+
diverse) projects:
740+
741+
- [db-migrate](https://db-migrate.readthedocs.io/en/latest/Getting%20Started/commands/)
742+
- [sqitch](https://sqitch.org/)
743+
- [Flyway](https://flywaydb.org/)
744+
- [migra](https://github.com/djrobstep/migra)
745+
746+
## Node.js versioning policy
747+
748+
We only support LTS versions of Node.js; the currently supported versions are:
749+
750+
- Node v12.x
751+
- Node v14.x
752+
753+
Other versions of Node may work, but are not officially supported.
754+
755+
Once a Node.js version becomes "unsupported" (i.e. the maintenance LTS window
756+
ends), this project will no longer support it either. We may drop support for
757+
unmaintained versions of Node.js in a **minor** release.
758+
746759
## Drift
747760
748761
> **NOTE**: drift only affects your local development database, it cannot occur

0 commit comments

Comments
 (0)