Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

For v 2.0+ we need to create an actual distribution package #316

Open
martindholmes opened this issue Sep 25, 2024 · 1 comment
Open

For v 2.0+ we need to create an actual distribution package #316

martindholmes opened this issue Sep 25, 2024 · 1 comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request release-blocker The dev branch must not be merged into master while a release-blocker bug is open.
Milestone

Comments

@martindholmes
Copy link
Collaborator

In addition to supplying a sample config file with full comments, we should actually have a script which builds a distribution for end-users. We can exclude lots of bits and pieces such as the ci and jenkins folders, the documentation config file, and so on, making for a less cluttered package. We should also have a decent version of the built documentation, which needs to function locally (so can't have a search), but could point to the online version which does.

@martindholmes martindholmes added documentation Improvements or additions to documentation enhancement New feature or request release-blocker The dev branch must not be merged into master while a release-blocker bug is open. labels Sep 25, 2024
@martindholmes martindholmes added this to the Release 2.0 milestone Sep 25, 2024
@martindholmes
Copy link
Collaborator Author

Starting a plan for this. We need:

  1. a buildRelease.xml ant file.
  2. a diagnostics.xsl file which checks a bunch of things before a release can be made.

The ant file should run the diagnostics, and parse the results to discover whether it's possible to proceed.
If not, it reports the fixes needed. These may be things like not being on a release branch; not having a documentation whatsnew div with the version matching the EDITION file; and more, as we think of things.
If so, it will:

  • build the documentation to create the single HTML version for distribution;
  • create a folder called release-x.y.z;
  • copy all content into it;
  • create zip and tar.gz archives of that folder.

Questions remaining:

  1. Do we include the test content so the user can run a local test, or is that confusing?
  2. Do we provide a sample template for a config file?
  3. Do we include the documentation build process as another potentially useful test?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request release-blocker The dev branch must not be merged into master while a release-blocker bug is open.
Projects
None yet
Development

No branches or pull requests

1 participant