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

Documentation actions improvements #5735

Merged
merged 151 commits into from
Sep 4, 2023
Merged

Conversation

Pikachu920
Copy link
Member

@Pikachu920 Pikachu920 commented Jun 6, 2023

Description

This PR improves the functionality of the doc actions. It adds the following:

  1. Javadoc exclusions as provided by @AyhamAl-Ali
  2. Fail gracefully when the SSH key secret is not available
  3. Deletes the nightly documentation of a branch when that branch is deleted
  4. Support doc templates at /docs/templates instead of /docs-templates (Move documentation into its own folder #5580)
  5. Attempt a rebase before committing to reduce chance of race condition
  6. Only push nightly documentation if there is actually a change between commits (this should cut down on useless commits to skript-docs)

Example workflows and commits:

  1. Javadoc filters: exclusions/workflow/generated javadocs
  2. Fail gracefully when SSH key secret is not available: workflow with secret/workflow without secret
  3. Deletion of nightly docs upon branch deletion: workflow/commit
  4. Support templates at /docs/templates instead of /docs-templates: workflow using docs/templates (ignore the failure to push, it's just cause its using a testing branch on skript-docs. I believe it'll work fine in practice.)
  5. Attempt a rebase before commit: workflow/logic
  6. Don't push changes if there were no changes to the docs: workflow with changes/workflow without changes

Target Minecraft Versions: N/A
Requirements: None
Related Issues: None

@Pikachu920 Pikachu920 changed the title Delete nightly documentation on branch delete Documentation actions improvements Aug 23, 2023
@Pikachu920 Pikachu920 marked this pull request as ready for review August 30, 2023 01:29
@TheLimeGlass
Copy link
Collaborator

Moving documentation to it's own folder #5580

Copy link
Member

@Moderocky Moderocky left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good. Thanks for your work on this.

@Pikachu920 Pikachu920 merged commit 72fdcda into SkriptLang:master Sep 4, 2023
4 checks passed
Moderocky pushed a commit to Moderocky/Skript that referenced this pull request Sep 16, 2023
---------

Co-authored-by: Ayham Al Ali <[email protected]>
Co-authored-by: LimeGlass <[email protected]>
Moderocky pushed a commit that referenced this pull request Sep 19, 2023
---------

Co-authored-by: Ayham Al Ali <[email protected]>
Co-authored-by: LimeGlass <[email protected]>
NotSoDelayed pushed a commit to NotSoDelayed/Skript that referenced this pull request Oct 30, 2023
---------

Co-authored-by: Ayham Al Ali <[email protected]>
Co-authored-by: LimeGlass <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Related to Skript's official documentation. enhancement Feature request, an issue about something that could be improved, or a PR improving something. github related Issues or Pull requests that affect the GitHub organization/repositories
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants