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

Course automation: Essay bibliography check & summary #1008

Merged
merged 1 commit into from
Mar 29, 2021
Merged

Course automation: Essay bibliography check & summary #1008

merged 1 commit into from
Mar 29, 2021

Conversation

amarhod
Copy link

@amarhod amarhod commented Mar 26, 2021

Members

Amar Hodzic (amarh@kth.se)

Natan Teferi Asegehegn (ntas@kth.se)

Proposal

We would like to create a Github Action that produces a PR comment with the number of references used as well as an excerpt from the reference list. This would simplify the TAs job in getting an overview without having to open the file and scroll down.
We are aware of another proposal that summarizes essays but it has no mention of references.

What the Action should do:

  • When a PR uses a specific label (e.g. essay), create a comment on that PR
  • The comment should have a reference count
  • The comment should include the reference list
  • The reference list should be stripped down based on verbosity level set in the code (e.g. remove "accessed date", URL etc)

Criterias it should fulfill:

  • Done before April 6
  • The task produces a PR comment
  • The task runs on a standard platform (Github Action)
  • The task is praised by the other students of this course
  • The code for the task is available and well documented

@SophieHYe SophieHYe self-assigned this Mar 29, 2021
@SophieHYe SophieHYe self-requested a review March 29, 2021 00:15
@SophieHYe
Copy link

SophieHYe commented Mar 29, 2021

Hi,
The summary of essay bibliography looks interesting. That will a nice reading list for all the students who love to explore the DevOps as much as possible. If would be great you could compared with the previous years essay as well, then we can see how many new/state-of-the-art work are reference in this year's essay.

I am merging your PR and look forward to your contributions. Thanks.

@SophieHYe SophieHYe merged commit 6c08624 into KTH:2021 Mar 29, 2021
arxra added a commit to arxra/devops-course that referenced this pull request Mar 29, 2021
* '2021' of github.com:KTH/devops-course: (52 commits)
  doc: Course automation proposal (KTH#1008)
  Adds essay proposal (KTH#1009)
  Create readme.md (KTH#996)
  Create README.md (KTH#995)
  doc: add essay proposal for devops course (KTH#988)
  Presentation Proposal: Continuous testing and its role & application within devops (KTH#1026)
  Executable tutorial: nginx on vagrant box (KTH#956)
  Presentation week2 (KTH#1005)
  Course automation: Verify pull request content changes (KTH#981)
  Presentation: The history of devops (KTH#1004)
  Presentation : Influence of DevOps in Software testing (KTH#984)
  Course automation: Automatic validation and labeling (KTH#949)
  Essay: Automated tests for infrastructure code (KTH#999)
  Demo: How to add code coverage report on Github using Clover and GitHub Action (KTH#994)
  Demo proposal: Implementation of Docker to React Application (KTH#992)
  Course Automation: automatic labels (KTH#932)
  Update README.md
  Reschedule Nix presentation to week 2 (KTH#1001)
  Course Automation: Upvote other students' work (KTH#991)
  Presentation Kanban vs Scrum (KTH#993)
  ...
SophieHYe pushed a commit that referenced this pull request Apr 29, 2021
…ary (#1117)

* doc: Course automation proposal

* Add GitHub action that automatically counts task registrations (#918)

* Add tutorial proposal (#1015)

Co-authored-by: LaraRos <rostami.lara@gmail.com>

Co-authored-by: LaraRos <rostami.lara@gmail.com>

* Add essay readme (#1020)

* Executable Tutorial Proposal: Setting up a Jenkins CI/CD pipeline for deploying to Docker Hub (#1028)

* Executable tutorial proposal: integrate TeamCity with Docker (#1025)

Co-authored-by: César Soto Valero <cesarsotovalero@gmail.com>

* Essay: Comparison of Kubernetes and Nomad (#1023)

Co-authored-by: Dina Lerjevik <lerjevik@kth.se>

* Essay proposal: BDD in DevOps (#1032)

* Update README.md (#1039)

* doc: remove confusion about feedback on videos

* Update README.md

* feat: Added workflow file for bibliography summary action #1008

* doc: Final submission update #1008

* doc: Fixed typos

* fix: Changed workflow to use v1 release instead

Co-authored-by: Long Zhang <zhanglong3030@qq.com>
Co-authored-by: Markus Wesslén <markus.wesslen@gmail.com>
Co-authored-by: LaraRos <rostami.lara@gmail.com>
Co-authored-by: Justin Arieltan <agriad1@yahoo.com>
Co-authored-by: Christopher Gustafson <christopher.gustafson@outlook.com>
Co-authored-by: Chen, Zidi <51125655+Chen-Zidi@users.noreply.github.com>
Co-authored-by: César Soto Valero <cesarsotovalero@gmail.com>
Co-authored-by: dmariel <34478937+dmariel@users.noreply.github.com>
Co-authored-by: Dina Lerjevik <lerjevik@kth.se>
Co-authored-by: anorangesky <35503355+anorangesky@users.noreply.github.com>
Co-authored-by: heeenkie <35926672+heeenkie@users.noreply.github.com>
Co-authored-by: Martin Monperrus <martin.monperrus@gnieh.org>
Co-authored-by: Sophie H Ye <he_ye_90s@hotmail.com>
monperrus added a commit that referenced this pull request Sep 15, 2022
…ary (#1117)

* doc: Course automation proposal

* Add GitHub action that automatically counts task registrations (#918)

* Add tutorial proposal (#1015)

Co-authored-by: LaraRos <rostami.lara@gmail.com>

Co-authored-by: LaraRos <rostami.lara@gmail.com>

* Add essay readme (#1020)

* Executable Tutorial Proposal: Setting up a Jenkins CI/CD pipeline for deploying to Docker Hub (#1028)

* Executable tutorial proposal: integrate TeamCity with Docker (#1025)

Co-authored-by: César Soto Valero <cesarsotovalero@gmail.com>

* Essay: Comparison of Kubernetes and Nomad (#1023)

Co-authored-by: Dina Lerjevik <lerjevik@kth.se>

* Essay proposal: BDD in DevOps (#1032)

* Update README.md (#1039)

* doc: remove confusion about feedback on videos

* Update README.md

* feat: Added workflow file for bibliography summary action #1008

* doc: Final submission update #1008

* doc: Fixed typos

* fix: Changed workflow to use v1 release instead

Co-authored-by: Long Zhang <zhanglong3030@qq.com>
Co-authored-by: Markus Wesslén <markus.wesslen@gmail.com>
Co-authored-by: LaraRos <rostami.lara@gmail.com>
Co-authored-by: Justin Arieltan <agriad1@yahoo.com>
Co-authored-by: Christopher Gustafson <christopher.gustafson@outlook.com>
Co-authored-by: Chen, Zidi <51125655+Chen-Zidi@users.noreply.github.com>
Co-authored-by: César Soto Valero <cesarsotovalero@gmail.com>
Co-authored-by: dmariel <34478937+dmariel@users.noreply.github.com>
Co-authored-by: Dina Lerjevik <lerjevik@kth.se>
Co-authored-by: anorangesky <35503355+anorangesky@users.noreply.github.com>
Co-authored-by: heeenkie <35926672+heeenkie@users.noreply.github.com>
Co-authored-by: Martin Monperrus <martin.monperrus@gnieh.org>
Co-authored-by: Sophie H Ye <he_ye_90s@hotmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants