SauSaGe VS SiteGenerationTool

The following is my PR to his repo to test his CI: pull18

This week, I set up CI for my SSG project. This involves creating a GitHub workflow for GitHub Actions to use. I started with one of the starter workflows. Specifically I used the msbuild one. To give a brief explanation of what adding this file will do, upon pushing changes or, a pull request it will create an environment that can be used to run my program. This is helpful if any tests, or other checks need to be made to verify that everything is in working order after changes to the project have been made.

This week, I added a testing module to my SSG. Since my SSG was created using C++, I used Catch2 as my testing framework. I chose Catch2 as my testing framework since it seemed to be the most popular among C++ developers, and it was all contained within a single header file.

The experience in rebasing my code went very smoothly. I was surprised how easy it was to squash all my multiple commits into a single commit. The process was straightforward with a bit of guidance from the on-screen instructions as well as the instructions of the lab. This was the commit I made.

In this lab, I added to my SSG program (SauSaGe) in order to demonstrate the process of working with and merging parallel branches in a project.

This week I've been working on adding some features to SauSaGe - Static Site Generator (SSG) built with C++.

Issue #1: Multiple new lines add empty unclosed 'p' tags.

1. This was an issue that I knew was present in my code but I had yet to find a solution for. At the time of writing, it has been solved using an else if condition instead of an else. 2. This issue I had not thought of, since in many cases command-line applications can be executed from any location. However, without changing PATH variables (which may be too advanced for some users), this issue will remain present. So, I will have to do with simply placing a step in the instructions to execute the application directly through the command-line. 3. This issue was found to be intentional. It remains in place because it prevents .html files to be created out of sub-directory files in the initially inputted directory. 4. This issue was a little more difficult to solve without increasing the coupling of my Text module and main function. I had to resort to placing the open and closing HTML tags as a constant variable in the Text module's header file in order to reduce code repetition. 5. This issue was the similar to issue #5 that I posted on my partner's repo. Since I used a different programming language to code my application than my partner, I had to find my own solution to this issue. The fix itself was straightforward using the filesystem standard library's functions.

I just finished making my SauSaGe (Static Site Generator), excuse my idea of a "creative name".

My pull request involved updating syntax for some files in order to modernize the code in the project. I've had minimal exposure to Python, only having worked on another student's SSG made in Python, so it was somewhat of a shift to understand the basics of Python syntax. There isn't much more to say at the moment, but I will update this post as I receive feedback from the maintainers and hopefully have my pull request merged.

Here is an example workflow from my class mate Rudy's recent PR to my repository where he added some testing to see that my CI was working: Successful actions run.

How did your partner's repo and testing setup differ from yours? I worked with sfrunza13 once again on his SSG. Even though he used Python and I used C++ for our projects, the tests were similar since they both accomplish the same task. With the understanding of the task being performed, the difference between languages did not matter significantly. Both the projects and tests were very similar. Although one significant difference was that my repo outsourced the Markdown parsing to a external module.

The issue that I filed for this:Replace index w navbar The commit:7435a0

For Lab 4, I added support for reading and parsing a JSON config file to Stefan's SSG.

In the third lab that we were assigned in my Opensource Dev course at Seneca we were taught how to checkout feature branches so that we can work on multiple features independently and how to later merge them all to the main branch and resolve conflicts. To do so we yet again used our simple site generators

The project I chose to contribute to was SiteGenerationTool by sfrunza13. I decided to add features to the project to be able to open .md files, and for .html files created using these files to have bold and italics Markdown indicators to be replaced with the appropriate HTML tags.

It turns out that writing SSG in python is not that complicated. (https://github.com/sfrunza13/SiteGenerationTool) The code that I was reading is very clear and concise, even if you are not very good at this language.

My first closed issue https://github.com/sfrunza13/SiteGenerationTool/issues/1