HedgeDoc - Ideas grow better together
Find a file
David Mehren 5078b863c6 ci: build and test docker image
This adds a new workflow performing these steps:
- A development docker image is built and pushed to GHCR as
  'hedgedoc-ci' labeled with the commit hash
- Tests are run with the image
- If the tests are successful, a production image is built and
  pushed to GHCR as 'hedgedoc' labeled with the branch, version tag
  if available and the commit hash

At a later time, the built dev image can also be used to run E2E tests
with the other supported databases. Currently, this is not yet possible,
as the database is always expected to run on localhost, not other hosts.

Signed-off-by: David Mehren <git@herrmehren.de>
2022-03-21 14:57:27 +01:00
.github ci: build and test docker image 2022-03-21 14:57:27 +01:00
.idea/copyright fixed copyright template for idea 2021-01-09 22:47:17 +01:00
.reuse Reuse: Fix typo in HedgeDoc Icon Usage Guidelines 2021-04-25 12:57:41 +02:00
.yarn build: add workspace-tools yarn plugin 2022-03-07 13:55:07 +01:00
docker chore(deps): update node.js to 1ef397a 2022-03-19 09:55:33 +00:00
docs chore(deps): update dependency pymdown-extensions to v9.3 2022-03-20 19:55:19 +01:00
LICENSES Add REUSE license info for Yarn 2 2021-09-05 18:22:47 +02:00
public Add serving of static assets under the relative URL '/public' 2021-04-25 14:41:38 +02:00
src fix param description of updateNotePermissions 2022-03-13 21:33:02 +01:00
test Fix e2e test for moved permission functions 2022-03-13 21:33:02 +01:00
.dockerignore feat: add a dockerfile 2022-03-07 13:55:07 +01:00
.editorconfig Change year in copyright to 2021 2021-01-06 21:36:07 +01:00
.env.example Config: Fix .env.example file 2021-02-14 17:37:05 +01:00
.eslintrc.js build(eslint): allow numbered agent objects 2022-01-27 21:05:17 +01:00
.gitignore Setup .gitignore for Yarn 2 2021-09-05 18:05:26 +02:00
.mailmap Update mailmap and AUTHORS 2022-01-23 22:13:54 +01:00
.mailmap.license Change year in copyright to 2021 2021-01-06 21:36:07 +01:00
.prettierrc Update .prettierrc for sort-imports v3 2021-10-27 17:58:00 +02:00
.prettierrc.license Change year in copyright to 2021 2021-01-06 21:36:07 +01:00
.yarnrc.yml build: add workspace-tools yarn plugin 2022-03-07 13:55:07 +01:00
.yarnrc.yml.license Add REUSE license info for Yarn 2 2021-09-05 18:22:47 +02:00
AUTHORS Update mailmap and AUTHORS 2022-01-23 22:13:54 +01:00
CHANGELOG.md Use 'HedgeDoc' in changelog and license 2022-02-14 11:50:02 +01:00
CODE_OF_CONDUCT.md Change year in copyright to 2021 2021-01-06 21:36:07 +01:00
codecov.yml ci(codecov): Wait for 2 builds to be submitted 2021-12-05 22:22:46 +01:00
CONTRIBUTING.md docs: added sign-off guide to CONTRIBUTING.md 2021-12-18 15:47:12 +01:00
eslint-local-rules.js ESLint: Add custom rule 'correct-logger-context' 2021-05-02 19:45:47 +02:00
jest-e2e.json Move tsconfig.test.json to test directory 2021-10-14 19:55:55 +02:00
jest-e2e.json.license Change year in copyright to 2021 2021-01-06 21:36:07 +01:00
LICENSE Use 'HedgeDoc' in changelog and license 2022-02-14 11:50:02 +01:00
nest-cli.json Swagger: Enable comment parsing 2021-01-25 22:20:54 +01:00
nest-cli.json.license Change year in copyright to 2021 2021-01-06 21:36:07 +01:00
package.json chore(deps): update linters to v5.15.0 2022-03-20 19:54:47 +01:00
package.json.license Change year in copyright to 2021 2021-01-06 21:36:07 +01:00
README.md Update readme link to explanation page 2021-09-05 11:52:12 +02:00
renovate.json ci: enable renovate digest pinning 2022-03-07 14:18:46 +01:00
renovate.json.license Change year in copyright to 2021 2021-01-06 21:36:07 +01:00
SECURITY.md Update security.md to match state in master branch 2021-09-21 15:19:46 +02:00
tsconfig.build.json Add empty NestJS application 2020-07-21 21:24:56 +02:00
tsconfig.build.json.license Change year in copyright to 2021 2021-01-06 21:36:07 +01:00
tsconfig.json Remove typeRoots from tsconfig 2021-09-06 16:35:54 +02:00
tsconfig.json.license Change year in copyright to 2021 2021-01-06 21:36:07 +01:00
yarn.lock chore(deps): lock file maintenance 2022-03-21 05:49:13 +00:00
yarn.lock.license Change year in copyright to 2021 2021-01-06 21:36:07 +01:00

HedgeDoc Logo

#HedgeDoc on matrix.org version POEditor Mastodon Twitter REUSE Compliance Check Nest.JS CI codecov

HedgeDoc lets you create real-time collaborative markdown notes.

Getting Started

State of the project

HedgeDoc 1.x is stable and used around the world, but the codebase has grown over time, making it hard to add new features.
We are currently working on HedgeDoc 2, a complete rewrite of HedgeDoc. Please note the following:

  • This branch contains the latest development code and does not implement all features yet. If you are looking for the 1.x source code, have a look at the master branch.
  • HedgeDoc 2 will be split in two components: the backend (this repo) and the frontend in the react-client repo.
  • The 1.x release is maintenance-only. We do not accept feature requests or PRs for this release anymore and may choose to close non-critical bug reports, if the bug will be non-existent in 2.0.

Contributions

We welcome contributions!
Have a look at our contribution docs to find out how you can help. If you want to contribute to HedgeDoc 2, please join our development chat.

License

Licensed under AGPLv3. For our list of contributors, see AUTHORS.

The license does not include the HedgeDoc logo, whose terms of usage can be found in the github repository.