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

Pull Request: Refactor and Rename Document Conversion to Document Generation #6

Merged
merged 7 commits into from
Apr 16, 2024

Conversation

HlexNC
Copy link

@HlexNC HlexNC commented Apr 16, 2024

Overview

This pull request encompasses several critical changes aimed at transitioning from the "Document Conversion" concept to "Document Generation." This includes renaming directory paths, updating workflow actions, and modifying documentation and library usage instructions to reflect the new terminology and directory structures. Additionally, new functionalities for presentation generation have been introduced to the existing document library.

Changes

  1. Renaming Directories and Updating Workflow Paths:

    • Changed the npm package directory from /officegen-api to /privateomega-lib to align with new structural guidelines.
    • Updated GitHub workflow paths to trigger on pushes to the main branch, ensuring continuous integration and delivery are maintained for the new directory structure.
  2. Dependabot Configuration:

    • Modified the dependabot.yml configuration to reflect the new directory structure. This ensures our dependencies are kept up-to-date automatically.
  3. GitHub Workflows:

    • Introduced two new workflows for publishing npm packages:
      • publish-conversion.yml for the Document Conversion NPM Package.
      • publish-gen.yml for the Document Gen NPM Package.
    • These workflows are designed to automate the packaging and publishing process, triggered by changes to the main branch.
  4. Documentation Updates:

    • Updated all references from "Document Conversion" to "Document Gen" across various Markdown files within the officegen-api directory.
    • Revised setup and usage instructions to cater to the new package name and functionalities.
  5. Library Enhancements:

    • Added functions for creating and managing presentation structures and buffers within documentLibrary.js, expanding the utility of the library beyond document generation.
  6. Test Adjustments:

    • Reflected the renaming in test descriptions and expanded the test suite to cover the new functionalities introduced for presentation handling.

Implications

  • These changes necessitate updates to existing CI/CD pipelines and may require team members to reconfigure their local development environments to align with the new paths and dependencies.
  • Documentation hosted externally must also be updated to reflect these changes to ensure consistency and clarity for end-users.

This PR is a foundational step towards enhancing the flexibility and functionality of our NPM packages, ensuring they remain robust and scalable as we continue to expand our offerings.

@HlexNC HlexNC self-assigned this Apr 16, 2024
@HlexNC HlexNC added the enhancement New feature or request label Apr 16, 2024 — with GitHub Codespaces
@HlexNC HlexNC merged commit 0c0999a into main Apr 16, 2024
3 checks passed
@HlexNC HlexNC deleted the feature/refactor-npm-package branch April 24, 2024 10:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant