#8 step summary

[evealitaylor]

Configured the Dockerfile entrypoint to a new bash script entrypoint.sh which uses GITHUB_STEP_SUMMARY. Added documentation to the ReadMe to explain the step summary output.

Co-developed with @ZachCraw

Closes #8

[ZachCraw]

closes #8

[koppor]

Minor comments.

The consistency check only outputs the table without anything else? Isn't --porcelain needed?

Maybe you can add a screenshot of the action output.

[ZachCraw]

Minor comments.

The consistency check only outputs the table without anything else? Isn't --porcelain needed?

Maybe you can add a screenshot of the action output.

Apologies, yes you are correct. We overlooked that the porcelain tag was only present within our personal test suite and was not automatically added.

This should be fixed now.

The git update-index chmod+x entrypoint.sh command did not seem to work locally for our tests, however this hopefully is just a local git environment issue and it will work for other users after pulling from remote.

This was the test we performed using the example bib file within the README.md:

Input:

docker build --no-cache -t jabref-action-local .

docker run --rm \
  -v "$(pwd):/github/workspace" \
  -w /github/workspace \
  -e GITHUB_STEP_SUMMARY=/github/workspace/summary.md \
  jabref-action-local \
  --input=test_bib.bib

Output

entry type	citation key	Eprint	File	Number	Pages	URL
Article	Cooper_2007	-	-	o	o	-
Article	Corti_2009	-	-	o	o	-
Article	Di_Renzo_2012	-	-	o	o	-
Article	Ding_2006	-	-	o	-	-
Article	Fulton_1969	o	-	o	o	o
Article	Garcia_2018	-	-	o	-	-
Article	Hooper_2012	-	-	o	o	-
Article	Katz_2011	-	-	o	o	-
Article	Keen_2001	-	-	o	o	-
Article	LunaOstos_2024	-	?	o	o	-
Article	Macht_2007	-	-	o	o	-
Article	Parker_2006	-	-	o	o	-
Article	Scholey_2013	-	-	o	o	-
Article	Tan_2021	-	-	o	o	-
Article	Tokede_2011	-	-	o	o	-

[ZachCraw]

closes #8

[ZachCraw]

Hey @koppor , just wondering if we could get your opinion on the implementation above.

[koppor]

The git update-index chmod+x entrypoint.sh command did not seem to work locally for our tests, however this hopefully is just a local git environment issue and it will work for other users after pulling from remote.

1. What is your "local git environment"? - I do not know anything about your setup.
2. I think there is a -- missing somewhere in your command; then git should have errorred.

I fixed it at 85f7aeb (#10)

I also fixed "option '--porcelain' should be specified only once". Sorry for the confustion. I did not check the whole code on my own. I thought, you would have the capability to read the few lines of action.yml, too.

I also needed to fix the script itself: check-consistency was specified twice.

I added tee to be able to see the output at each call.

The tests showed me that multiple libraries are used -- I updated the thing to support that, too.

[koppor]

There is no CHANGELOG.md entry. I think, this is OK as the CHANGELOG.md did not start (yet).