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

feat: expressjs framework #784

Open
wants to merge 98 commits into
base: main
Choose a base branch
from
Open
Changes from 1 commit
Commits
Show all changes
98 commits
Select commit Hold shift + click to select a range
1bf14da
feat: expressjs framework extension
yanksyoon Jan 2, 2025
5d5b8ba
test: expressjs framework extension unit tests
yanksyoon Jan 2, 2025
8afa87e
fix: lint
yanksyoon Jan 2, 2025
a887f00
fix: user prime app prefixing
yanksyoon Jan 2, 2025
be56040
test: spread test for express js
yanksyoon Jan 2, 2025
91e87e9
fix: linting
yanksyoon Jan 2, 2025
9d9be67
feat: add template
yanksyoon Jan 2, 2025
cb84f17
fix: app project dir
yanksyoon Jan 2, 2025
0af6e6a
chore: comment runtime debs
yanksyoon Jan 3, 2025
eacf0a1
chore: rename organise to organize
yanksyoon Jan 3, 2025
dc787d0
test: fix tests
yanksyoon Jan 3, 2025
98fbdd9
chore: move ca-certificates_data to slice def
yanksyoon Jan 3, 2025
d7c51cd
chore: move node slice
yanksyoon Jan 3, 2025
b7a21a5
chore: retrigger ci
yanksyoon Jan 3, 2025
9233492
fix: add node build dependency
yanksyoon Jan 3, 2025
acc3c05
fix: use nodejs package
yanksyoon Jan 3, 2025
b6b9ca2
fix: add npm plugin dependency
yanksyoon Jan 3, 2025
a1b5209
fix: add plugin dependencies
yanksyoon Jan 3, 2025
9a69970
fix: nodejs as deb
yanksyoon Jan 3, 2025
f55e87b
fix: nodejs package/slice separation
yanksyoon Jan 6, 2025
544434b
ci: retrigger (LAUCHPAD DOWN)
yanksyoon Jan 6, 2025
6ba9c5a
fix: prime default after deletion
yanksyoon Jan 6, 2025
82bbf94
feat: node version option fallthrough
yanksyoon Jan 9, 2025
582811b
chore: add rockcraft to supported extensions
yanksyoon Jan 10, 2025
650cab0
docs: expressjs tutorial
yanksyoon Jan 10, 2025
a25ea2a
chore: separate out dependencies part
yanksyoon Jan 10, 2025
dc3b61b
feat: add generation template
yanksyoon Jan 10, 2025
6e68078
docs: expressjs reference
yanksyoon Jan 10, 2025
024ea8e
docs: fix linting line too long
yanksyoon Jan 10, 2025
685d9be
fix: 24.04 package clash fix
yanksyoon Jan 10, 2025
b900591
fix: move stage packages
yanksyoon Jan 10, 2025
cea6fe4
fix: npmrc install
yanksyoon Jan 13, 2025
b20ebea
fix: tutorial code fix
yanksyoon Jan 13, 2025
a504403
fix: pebble lint
yanksyoon Jan 13, 2025
f6d31a2
test: add back build base
yanksyoon Jan 13, 2025
2a46cab
fix: base change
yanksyoon Jan 13, 2025
63b914d
docs: documentation improvements
yanksyoon Jan 14, 2025
c8d9ce5
test: add corner cases
yanksyoon Jan 14, 2025
c319aa2
chore: inline constants & match service def
yanksyoon Jan 14, 2025
a3c080a
chore: update template guildeline
yanksyoon Jan 14, 2025
dee32bf
docs: tutorial docs wording improvements & code highlighting
yanksyoon Jan 15, 2025
24ae419
feat: expressjs user override node with different bases
yanksyoon Jan 20, 2025
908581a
docs: expressjs user-override node version template
yanksyoon Jan 20, 2025
a5423c6
docs: reference to node-version override
yanksyoon Jan 20, 2025
f33666f
docs: update expressjs runtime codeblock to match template
yanksyoon Jan 20, 2025
37fa47c
docs: expressjs tutorial specify run directory
yanksyoon Jan 20, 2025
c1c8e28
docs: expressjs tutorial fix sumaary
yanksyoon Jan 20, 2025
02675c7
chore: organize expressjs extension code
yanksyoon Jan 20, 2025
c3af5c2
test: set node env to production
yanksyoon Jan 20, 2025
fd934b9
chore: remove user custom packages part
yanksyoon Jan 21, 2025
e3ea01b
chore: remove empty parts from rock gen
yanksyoon Jan 21, 2025
3589757
docs: re-order framework extensions list
yanksyoon Jan 22, 2025
752ce93
docs: remove customizing runtime deps part
yanksyoon Jan 22, 2025
c145919
docs: explain unsupported runtime dependencies issue
yanksyoon Jan 22, 2025
a90e80b
docs: expressjs explaination of different combinations
yanksyoon Jan 22, 2025
81c4abb
docs: pin tutorial express generator version
yanksyoon Jan 23, 2025
eca73e3
docs: reword parts
yanksyoon Jan 23, 2025
da5b5fe
docs: formatting & spelling
yanksyoon Jan 23, 2025
4128d2d
docs: fix linting
yanksyoon Jan 23, 2025
0531361
docs: update tutorial documentation
yanksyoon Jan 24, 2025
b62355e
docs: tutorial curl --fail flag
yanksyoon Jan 24, 2025
9c2dfb9
docs: lint fixes for tutorial
yanksyoon Jan 24, 2025
7f9aeb7
chore: clean up code
yanksyoon Jan 27, 2025
2ca47b2
chore: trigger CI
yanksyoon Jan 31, 2025
4f457dd
docs: curl with fail flags
yanksyoon Feb 10, 2025
2219f20
docs: tutorial refer to file
yanksyoon Feb 10, 2025
dc9b38c
test: node version check
yanksyoon Feb 10, 2025
d9fd9e0
test: fix indentation for rockcraft yaml npm version override
yanksyoon Feb 10, 2025
e82ec96
test: fix version check
yanksyoon Feb 10, 2025
b55012b
chore: revert changes to build-docs
yanksyoon Feb 11, 2025
420b342
docs: grammar improvement & sphinx syntax fixes
yanksyoon Feb 11, 2025
48b2ceb
docs: remove unsurprisingly vocab
yanksyoon Feb 11, 2025
d3e9f8b
docs: append newline for code-block rendering
yanksyoon Feb 12, 2025
7acb5d0
docs: update docs reference link
yanksyoon Feb 13, 2025
425be9f
docs: improve ExpressJS docs grammar
yanksyoon Feb 13, 2025
12319c9
docs: update ubuntu base syntax
yanksyoon Feb 13, 2025
5db1dfe
docs: improve documentation grammar
yanksyoon Feb 13, 2025
2619fdc
docs: change logs to terminal directive
yanksyoon Feb 13, 2025
0401fcf
chore: remove unnecessary ubuntu base replacement
yanksyoon Feb 17, 2025
15a589a
docs: start from 24.04 base for tutorial
yanksyoon Feb 18, 2025
d41ea86
docs: fix tutorial append time app command
yanksyoon Feb 19, 2025
700a625
fix: node version override from nodejs_bins fix
yanksyoon Feb 24, 2025
d171762
test: increase test timeout (default 15)
yanksyoon Feb 24, 2025
89fc837
fix: supporting libs for npm plugin installed libs
yanksyoon Feb 25, 2025
a58f665
fix: bare image with nodejs included
yanksyoon Feb 25, 2025
fcf14cf
docs: formatting and minor grammar issues
yanksyoon Feb 26, 2025
3864e55
docs: move build bases documentation to how-to
yanksyoon Mar 3, 2025
ba5e6b3
docs: clarify ambiguous grammar
yanksyoon Mar 3, 2025
5bc4784
docs: match Go tutorial style
yanksyoon Mar 3, 2025
e897513
chore: remove node_modules before installation
yanksyoon Mar 3, 2025
35da292
docs: lint
yanksyoon Mar 3, 2025
671c606
docs: fix broken links
yanksyoon Mar 3, 2025
8ec0ca4
docs: fix references
yanksyoon Mar 3, 2025
06d3582
docs: improve base difference explanations
yanksyoon Mar 6, 2025
903a3fb
docs: remove nesting
yanksyoon Mar 6, 2025
468f03d
docs: NodeJS to Node.js spelling fix
yanksyoon Mar 6, 2025
bd466b9
Merge branch 'main' into feat/expressjs-framework
tigarmo Mar 6, 2025
3da438f
docs: update docs/how-to/index.rst
tigarmo Mar 6, 2025
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
docs: remove customizing runtime deps part
yanksyoon committed Jan 22, 2025
commit 752ce93172b3c866deee4704bd8109c5b0a80a96
25 changes: 9 additions & 16 deletions docs/reference/extensions/expressjs-framework.rst
Original file line number Diff line number Diff line change
@@ -36,27 +36,20 @@ example:
parts:
expressjs-framework/install-app:
npm-include-node: true
npm-node-version: node
npm-node-version: 20.12.2

A corressponding Ubuntu packaged Node version will be provided by default if
not specified.
For more examples of npm-node-version options, see:
https://documentation.ubuntu.com/rockcraft/en/1.5.3/common/craft-parts/reference/plugins/npm_plugin/#examples

If you don't customise the version of node, it will be installed from the Ubuntu
package repository.

``parts`` > ``expressjs-framework/runtime:`` > ``stage-packages``
=================================================================

You can use this key to specify any dependencies required for your ExpressJS
application. In the following example we use it to specify ``libpq-dev``:

.. code-block:: yaml

parts:
expressjs-framework/runtime:
stage-packages:
# when using the default provided node version, the npm package is
# required.
# - npm
# list required packages or slices for your ExpressJS application below.
- libpq-dev
Customizing additional runtime dependencies is not supported at the moment due
to an issue with the
`NPM plugin <https://github.com/canonical/rockcraft/issues/790>`_.

Useful links
============