Environment variables that Snapcraft exposes

Lin-Buo-Ren · September 26, 2018, 8:12am

NOTE: This table is NOT complete nor error-free, feel free to extend/fix it.

Name & Description	Availability	Typical Values
`CFLAGS` Flags to pass to the C compiler	build step?	`-I_source_tree_dir_/stage/include`
`CPPFLAGS` Flags to pass to the C preprocessor	build step?	`-I_source_tree_dir_/stage/include`
`CXXFLAGS` Flags to pass to the C++ compiler	build step?	`-I_source_tree_dir_/stage/include`
`LANG` Locale settings	always?	`C.UTF-8`
`LD_LIBRARY_PATH` Dynamic Linker(man: ld.so) shared library search paths	build, stage, prime?	`:_source_tree_dir_/stage/lib:_source_tree_dir_/stage/usr/lib:_source_tree_dir_/stage/lib/_debian_multiarch_tuple_:_source_tree_dir_/stage/usr/lib/_debian_multiarch_tuple_`
`PATH` Runtime command search PATHs, separated with colons(`:`)	build, stage, prime?	(in build step) `_source_tree_dir_/stage/usr/sbin:_source_tree_dir_/stage/usr/bin:_source_tree_dir_/stage/sbin:_source_tree_dir_/stage/bin:_source_tree_dir_/parts/_part_name_/install/usr/sbin:_source_tree_dir_/parts/_part_name_/install/usr/bin:_source_tree_dir_/parts/_part_name_/install/sbin:_source_tree_dir_/parts/_part_name_/install/bin:/home/ubuntu/bin:/home/ubuntu/.local/bin:/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin:/snap/bin` (in stage/prime step) T.B.A.
`PERL5LIB` Library search path for Perl	build, stage, prime?	`_source_tree_dir_/stage/usr/share/perl5/`
`PKG_CONFIG_PATH` A colon-separated list of directories to search for .pc files. The default directory will always be searched after searching the path; the default is libdir/pkgconfig:datadir/pkgconfig where libdir is the libdir for pkg-config and datadir is the datadir for pkg-config when it was installed. Refer pkg-config(1) for more info.	build?	`:_source_tree_dir_/stage/lib/pkgconfig`
`PWD` Present working directory	always	(in pull step) `_source_tree_dir_/parts/_part_name_/src` (in build step) `_source_tree_dir_/parts/_part_name_/build` (in stage step) `_source_tree_dir_/stage` (in prime step) `_source_tree_dir_/prime`
`SHELL` The script intepreter’s path	always	`/bin/bash`
`SNAPCRAFT_ARCH_TRIPLET` The Debian Multiarch triplet string of the target processor architecture	always?	`x86_64-linux-gnu` `i386-linux-gnu` (Refer Multiarch/Tuples - Debian Wiki for more)
`SNAPCRAFT_EXTENSIONS_DIR`	?	`/snap/snapcraft/_snapcraft_snap_revision_/share/snapcraft/extensions` for snap build
`SNAPCRAFT_INTERPRETER` The Python interpreter that runs snapcraft	always?	`/snap/snapcraft/_snapcraft_snap_revision_/usr/bin/python3` (for snap the snap distribution of Snapcraft)
`SNAPCRAFT_PARALLEL_BUILD_COUNT` ?	build step?	`4` for a 4 core/thread processor system
`SNAPCRAFT_PART_BUILD` The build directory of the building part	build	`_source_tree_dir_/parts/_part_name_/build`
`SNAPCRAFT_PART_INSTALL` The path of the install directory of the part	`build` step	`_source_tree_dir_/parts/_part_name_/install`
`SNAPCRAFT_PART_SRC` The path of the src directory of the building part	build	`_source_tree_dir_/parts/_part_name_/src`
`SNAPCRAFT_PRIME` The path of the prime directory	build, stage, prime?	`_source_tree_dir_/prime`
`SNAPCRAFT_PROJECT_DIR` The path of the Snapcraft project’s root directory, may be in a different fashion in different Snapcraft build providers	override-step	`/home/_user_name_/mysnaps/_snap_name_` (in `--destructive-mode`) `/root/project` (in LXD/Multipass build providers)
`SNAPCRAFT_PROJECT_GRADE` The `grade` of the snap	always?	`[devel
`SNAPCRAFT_PROJECT_NAME` The `name` of the snap	always?	`_snap_name_`
`SNAPCRAFT_PROJECT_VERSION` The `version` key’s value of the snap	always?	`git`
`SNAPCRAFT_STAGE` The absolute path of the `stage` directory	`stage` step	`_source_tree_dir_/stage`
`SNAPCRAFTCTL_CALL_FIFO`	?	`/tmp/tmpXXXXXXXX/function_call`
`SNAPCRAFTCTL_FEEDBACK_FIFO`	?	`/tmp/tmpXXXXXXXX/call_feedback`

Reference

github.com

canonical/snapcraft/blob/cbd1854d9a9cfad55f7146664d3e6d15f8e3874d/snapcraft/internal/project_loader/_env.py

# -*- Mode:Python; indent-tabs-mode:nil; tab-width:4 -*-
#
# Copyright (C) 2017 Canonical Ltd
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License version 3 as
# published by the Free Software Foundation.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program.  If not, see <http://www.gnu.org/licenses/>.
from snapcraft import formatting_utils, project
from snapcraft.internal import common, elf, pluginhandler

from typing import Dict, List

This file has been truncated. show original

github.com

canonical/snapcraft/blob/cbd1854d9a9cfad55f7146664d3e6d15f8e3874d/snapcraft/internal/common.py

# -*- Mode:Python; indent-tabs-mode:nil; tab-width:4 -*-
#
# Copyright (C) 2015-2017 Canonical Ltd
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License version 3 as
# published by the Free Software Foundation.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program.  If not, see <http://www.gnu.org/licenses/>.

# Data/methods shared between plugins and snapcraft
import glob
import logging
import math

This file has been truncated. show original

Saviq · September 26, 2018, 9:16am

@Lin-Buo-Ren I fixed the formatting so it actually gets displayed as a table.

Lin-Buo-Ren · September 26, 2018, 9:56am

Thanks! Just got busy while writing this topic so I posted it as-is.

rpjday · January 24, 2022, 2:41pm

“SNAPCRAFT_PARALLEL_BUILD_COUNT” occurs in the above table twice; I will let others higher up the food chain decide where it belongs.

Lin-Buo-Ren · January 24, 2022, 3:09pm

The first occurrence is proper as the table is sorted in alphabetical order, thanks for your heads-up.