ponylang / library-documentation-action Goto Github PK

To be released once #13 is merged.

At the moment, no ponylang organizations have any libraries that include multiple top-level packages.

There's no support for them in any of our makefiles, documentation building scripts etc.

The workflow pr.yml is referencing action actions/checkout using references v1. However this reference is missing the commit a6747255bd19d7a757dbdda8c654a9f84db19839 which may contain fix to the some vulnerability.
The vulnerability fix that is missing by actions version could be related to:
(1) CVE fix
(2) upgrade of vulnerable dependency
(3) fix to secret leak and others.
Please consider to update the reference to the action.

The workflow announce-a-release.yml is referencing action actions/checkout using references v1. However this reference is missing the commit a6747255bd19d7a757dbdda8c654a9f84db19839 which may contain fix to the some vulnerability.
The vulnerability fix that is missing by actions version could be related to:
(1) CVE fix
(2) upgrade of vulnerable dependency
(3) fix to secret leak and others.
Please consider to update the reference to the action.

Currently documentation generation won't work for libraries like glob that rely on other libraries. This issue is because currently it is assumed that all external references are to the standard library.

To fix this, we needto examine information from corral.json to figure out what the dependencies are and in an as yet undetermined way, figure out what classes come from the dependency and where its documentation is stored.

At the moment, no work has been done to deal with libraries where the package contains subpackages like

• net
  • foo
  • bar

documentation ins net/foo and net/bar won't be correctly linked to and might have other issues.

Custom domains require an additional file to be installed in the documentation repository. At this time, we don't have a way to add additional files in as part of the build.

See: https://docs.github.com/en/github/working-with-github-pages/managing-a-custom-domain-for-your-github-pages-site

To pick up breaking change to ponyc once 0.47.0 is released

Model on appdirs.

git reset command fails if the generated-documentation branch doesn't already exist. Simplest way to deal with would be the catch the exception and carry on.