AL-Go icon indicating copy to clipboard operation
AL-Go copied to clipboard

Ignore /docs in cicd workflow

Open msomp opened this issue 2 years ago • 4 comments

Hi Freddy and Team,

as I'm using GitHub Pages for documentation purpose, it would be great if the complete /docs path could be ignored in cicd. Even if the docs folder (and subfolders) mainly contains .md files (which are already ignored), there may be also other filetypes which now may trigger an unnecessary start of cicd workflow. /docs is btw a standard GitHub folder to built GitHub pages from selected branch.

Thanks.

msomp avatar Mar 09 '23 09:03 msomp

Sounds like a good idea. Will probably make paths-ignore configurable and add /docs to the default.

freddydk avatar Mar 13 '23 10:03 freddydk

Will there be future AL-GO support for auto-publishing source code documentation using aldoc.exe as part of the release action? (Incl. publishing documentation from the private source repo to a public github (pages) repo)

References

  • https://github.com/orgs/microsoft/projects/521/views/1?filterQuery=doc&pane=issue&itemId=27095580
  • https://svirlan.com/business-central-aldoc-docfx-generate-github-page-to-host-your-al-documentation/

fvet avatar Oct 19 '23 06:10 fvet

Yes, working on that - https://github.com/microsoft/AL-Go/pull/760 Example: https://microsoft.github.io/bcsamples-bingmaps.pte/index.html

As you can see in the sample, it will create documentation for latest (work in progress) but also for shipped versions on the same site and you can determine how many versions you want.

Will come in preview later this month is the plan

freddydk avatar Oct 19 '23 13:10 freddydk

Nice work, looks promising 👍

fvet avatar Oct 19 '23 13:10 fvet