gbv / jskos-server

Web service to access JSKOS data
https://coli-conc.gbv.de/api/
MIT License
6 stars 4 forks source link

What else is needed for a 1.2.0 release? #131

Closed stefandesu closed 3 years ago

stefandesu commented 3 years ago

What else?

nichtich commented 3 years ago
stefandesu commented 3 years ago
  • publish as package at npm (?)

What exactly should be published to npm? I mean it doesn't make sense to install it as dependency for another package, and I don't think it makes sense to globally install it as an executable.

  • do you want more extensive code review?

That would probably be good. I guess this would mean that we don't commit directly to dev either, but rather work in feature branches and merge each branch separately after code review.

I'll go through the code in the next few days, looking for parts that should still be adjusted. Maybe afterwards you can take a look as well.

stefandesu commented 3 years ago

Suggested release notes:

- Added write endpoints for concept schemes and concepts. (#93)
- Deprecated old import script, added new scripts for import and reset. (#101)
    - See [documentation](https://github.com/gbv/jskos-server#data-import).
    - Also removed global `jskos-import` command.
- Added more filters to /voc:
    - by languages
    - by license (#115)
    - by subject
    - + basic sorting (#118)
- New endpoints `/voc/search` and `/voc/suggest`. (#121)
- Filter mappings by annotations. (#84)
- Adjust how concept hierarchies are handled. (#61)
- `/status`: Disabled endpoints are now set to `null`. (#119)
- Configuration files are checked via JSON Schema and startup is prevented if the file is invalid. (#96)
- Config: `verbosity` is now set to "warn" by default.
- `creator` and `contributor` fields are now handled via a middleware. (#122)
    - See [this comment](https://github.com/gbv/jskos-server/issues/122#issuecomment-723029967) for more details.
- Many minor fixes and improvements.

**Important notes:**
- The calls for importing data and removing data have changed! If you have any automations for this, make sure to adjust them to the new import/reset scripts.
- In order for scheme search to work, some adjustments are necessary. Please run `npm run upgrade` once to perform these adjustments.

Apart from the one small adjustment above, 1.2.0 is ready from my point of view. What do you think, @nichtich?

nichtich commented 3 years ago

What exactly should be published to npm?

The use case was setting up an example in coli-conc-examples to illustrate installation of jskos-server and importing some data. Should better be done with a shell script, no?

stefandesu commented 3 years ago

The use case was setting up an example in coli-conc-examples to illustrate installation of jskos-server and importing some data. Should better be done with a shell script, no?

For an example on how to install and set up jskos-server, I would suggest doing it the way you would normally do it - via shell, either through Git or Docker.

stefandesu commented 3 years ago

I will do some last testing tomorrow and then finally release 1.2.0.

stefandesu commented 3 years ago

Release is out! https://github.com/gbv/jskos-server/releases/tag/v1.2.0