search

abapGit / abapGit

Git client for ABAP
https://abapgit.org
MIT License
1.55k stars 537 forks source link

AbapDoc generation in CI? #5715

Closed Zeatynis closed 2 years ago

Zeatynis commented 2 years ago

Hello, have you heard about any plugin/tool which can generate documentation in HTML/MD format based on the current code pushed to git server? I wanted to have always up to date documentation. I thought that it can be achieved by running this plugin/tool in CI after pushing to master branch.

I ask here because this tool must be strictly connected to abapgit template of files (xml, abap).

larshp commented 2 years ago

https://abapedia.org generates lists of the artifacts and methods, however does not handle abapdoc (yet)

fabianlupa commented 2 years ago

https://github.com/i302574/abap-doc-export is a candidate but doesn't seem to have made it far.

larshp commented 2 years ago

and most of https://github.com/SAP/abap-file-formats-tools now runs in transpiler/open-abap runtime, part of what it does is reading and parsing the abapdoc, however generates json schema instead of documentation

fabianlupa commented 2 years ago

For generation in the ABAP stack there's currently an improvement request to be able to call the abapdoc generation in eclipse in CI.

larshp commented 2 years ago

For generation in the ABAP stack: IMHO its a bad idea, spinning up a ABAP stack, pulling the code, generating HTML.

Alternatively call the source system where the commit comes from to generate the documentation, however, it does not necessarily have the same code as in git

its 30+ minutes and 100's of EUR, vs a minute or two running for less than EUR 1.

fabianlupa commented 2 years ago

Oh for sure, I was more thinking of having access to a central system where the code is anyways (central development system scenario) and living with the desync between committed state and active state, as that generator in SAP standard is the only one that's finished / working currently as far as I know.

larshp commented 2 years ago

@Zeatynis ok to close?

Zeatynis commented 2 years ago

Yeah, sure. Just a little summary: all these solutions are far from perfect. Abapedia didn't work for me. It's strictly connected with transpiler which doesn't work with void types. I may be wrong though 😄

larshp commented 2 years ago

Abapedia does not transpile, it just takes the objects and makes html pages for it

Zeatynis commented 2 years ago

Abapedia does not transpile, it just takes the objects and makes html pages for it

If so, I'll check it again.

Zeatynis commented 2 years ago

OK. I thought that if it uses abaplint it also uses transpile. Anyway it worked. I just had to handle void types.